{ "openapi": "3.0.0", "info": { "title": "Payments Gateway API", "description": ">ℹ️ Onboarding guide\r\n>\r\n> Check the [Payments onboarding guide](https://developers.vtex.com/docs/guides/payments-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Payments and is organized by focusing on the developer's journey.\r\n\r\nThe Payments Gateway API allows you to get payment data and process your store's transactions.\r\n\r\n## Payments Gateway API Index\r\n\r\n### Installments\r\n\r\n- `GET` [Get installments options](https://developers.vtex.com/docs/api-reference/payments-gateway-api#get-/api/pvt/installments)\r\n\r\n### Configuration\r\n\r\n- `GET` [List all affiliations](https://developers.vtex.com/docs/api-reference/payments-gateway-api#get-/api/pvt/affiliations)\r\n- `POST` [Insert a new affiliation](https://developers.vtex.com/docs/api-reference/payments-gateway-api#post-/api/pvt/affiliations)\r\n- `PUT` [Update affiliation by ID](https://developers.vtex.com/docs/api-reference/payments-gateway-api#put-/api/pvt/affiliations/-affiliationId-)\r\n- `GET` [Get affiliation by ID](https://developers.vtex.com/docs/api-reference/payments-gateway-api#get-/api/pvt/affiliations/-affiliationId-)\r\n- `GET` [List all payment rules](https://developers.vtex.com/docs/api-reference/payments-gateway-api#get-/api/pvt/rules)\r\n- `POST` [Insert a new payment rule](https://developers.vtex.com/docs/api-reference/payments-gateway-api#post-/api/pvt/rules)\r\n- `GET` [Get payment rule by ID](https://developers.vtex.com/docs/api-reference/payments-gateway-api#get-/api/pvt/rules/-ruleId-)\r\n- `PUT` [Update payment rule by ID](https://developers.vtex.com/docs/api-reference/payments-gateway-api#put-/api/pvt/rules/-ruleId-)\r\n- `DELETE` [Delete payment rule by ID](https://developers.vtex.com/docs/api-reference/payments-gateway-api#delete-/api/pvt/rules/-ruleId-)\r\n- `GET` [List all available payment methods](https://developers.vtex.com/docs/api-reference/payments-gateway-api#get-/api/pvt/merchants/payment-systems)\r\n- `GET` [Get card data](https://developers.vtex.com/docs/api-reference/payments-gateway-api#get-/api/payments/pvt/account/-cardId-)\r\n\r\n### Transaction Process\r\n\r\n- `POST` [Starts a new transaction](https://developers.vtex.com/docs/api-reference/payments-gateway-api#post-/api/pvt/transactions)\r\n- `POST` [Send payments information](https://developers.vtex.com/docs/api-reference/payments-gateway-api#post-/api/pub/transactions/-transactionId-/payments)\r\n- `POST` [Send additional data](https://developers.vtex.com/docs/api-reference/payments-gateway-api#post-/api/pvt/transactions/-transactionId-/additional-data)\r\n- `PATCH` [Update additional data (optional)](https://developers.vtex.com/docs/api-reference/payments-gateway-api#patch-/api/pvt/transactions/-transactionId-/additional-data)\r\n- `POST` [Authorize new transaction](https://developers.vtex.com/docs/api-reference/payments-gateway-api#post-/api/pvt/transactions/-transactionId-/authorization-request)\r\n- `GET` [Get transaction details](https://developers.vtex.com/docs/api-reference/payments-gateway-api#get-/api/pvt/transactions/-transactionId-)\r\n- `GET` [Get payment details](https://developers.vtex.com/docs/api-reference/payments-gateway-api#get-/api/pvt/transactions/-transactionId-/payments/-paymentId-)\r\n- `GET` [Get transaction settlement details](https://developers.vtex.com/docs/api-reference/payments-gateway-api#get-/api/pvt/transactions/-transactionId-/settlements)\r\n\r\n### Transaction Flow\r\n\r\n- `POST` [Settle the transaction](https://developers.vtex.com/docs/api-reference/payments-gateway-api#post-/api/pvt/transactions/-transactionId-/settlement-request)\r\n- `POST` [Refund the transaction](https://developers.vtex.com/docs/api-reference/payments-gateway-api#post-/api/pvt/transactions/-transactionId-/refunding-request)\r\n- `POST` [Cancel the transaction](https://developers.vtex.com/docs/api-reference/payments-gateway-api#post-/api/pvt/transactions/-transactionId-/cancellation-request)\r\n\r\n### Payment Notification\r\n\r\n- `GET` [Send payment notification with payment ID](https://developers.vtex.com/docs/api-reference/payments-gateway-api#get-/api/payments/pvt/payments/-paymentId-/payment-notification)\r\n- `POST` [Send payment notification with payment ID, date, and value paid](https://developers.vtex.com/docs/api-reference/payments-gateway-api#post-/api/payments/pvt/payments/-paymentId-/payment-notification)\r\n", "version": "1.0" }, "servers": [ { "url": "https://{accountName}.vtexpayments.com.br", "description": "VTEX server URL.", "variables": { "accountName": { "description": "Name of the VTEX account. Used as part of the URL.", "default": "apiexamples" } } }, { "url": "https://api.vtexvault.com", "description": "VTEX Vault server URL." } ], "paths": { "/api/pvt/installments": { "servers": [ { "url": "https://{accountName}.vtexpayments.com.br", "description": "VTEX server URL.", "variables": { "accountName": { "description": "Name of the VTEX account. Used as part of the URL.", "default": "apiexamples" } } } ], "get": { "tags": [ "Installments" ], "summary": "Get installments options", "description": "Returns the best installment options according to the parameters informed in the request.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| PCI Gateway | Payment-Make Payments | **View Payment Data** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>\u2757 To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "operationId": "Installmentsoptions", "parameters": [ { "name": "request.value", "in": "query", "description": "Value to be divided into installments.", "required": true, "style": "form", "schema": { "type": "integer", "example": 10 } }, { "name": "request.salesChannel", "in": "query", "description": "Sales channel identification. Attribute created by the seller in their VTEX store configuration.", "required": false, "style": "form", "schema": { "type": "integer", "example": 1 } }, { "name": "request.paymentDetails[0].id", "in": "query", "description": "Payment system identification.", "required": false, "style": "form", "schema": { "type": "integer", "example": 2 } }, { "name": "request.paymentDetails[0].value", "in": "query", "description": "Total value paid in installments. If applied in the search, it must be equal to the `request.value` field.", "required": false, "style": "form", "schema": { "type": "integer", "example": 10 } }, { "name": "request.paymentDetails[0].bin", "in": "query", "description": "First six digits of the card number.", "required": false, "style": "form", "schema": { "type": "integer", "example": 411111 } }, { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" } ], "security": [ { "appKey": [], "appToken": [] }, { "VtexIdclientAutCookie": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidRequest" }, "example": { "value": 250, "installments": [ { "payment": { "id": 72, "name": null, "bin": null, "value": 250.0, "isDefault": false, "self": { "href": "/api/pvt/payment-systems/72" } }, "options": [ { "ruleId": "01a8d68b-9116-4655-83f8-3380f658ec04", "quantity": 1, "value": 250.0, "interestRate": 0.0, "isExternalInstallmentService": null, "interestTax": 0.0 }, { "ruleId": "01a8d68b-9116-4655-83f8-3380f658ec04", "quantity": 2, "value": 125.0, "interestRate": 0.0, "isExternalInstallmentService": null, "interestTax": 0.0 }, { "ruleId": "01a8d68b-9116-4655-83f8-3380f658ec04", "quantity": 3, "value": 83.33, "interestRate": 0.0, "isExternalInstallmentService": null, "interestTax": 0.0 }, { "ruleId": "01a8d68b-9116-4655-83f8-3380f658ec04", "quantity": 4, "value": 62.5, "interestRate": 0.0, "isExternalInstallmentService": null, "interestTax": 0.0 } ] }, { "payment": { "id": 5, "name": "ERedeV2 - Visa", "bin": null, "value": 10, "isDefault": false, "self": { "href": "/api/pvt/payment-systems/2" } }, "options": [ { "ruleId": "993d4d35-b64d-454d-8108-c560580160e0", "quantity": 1, "value": 250.0, "interestRate": 0.0, "isExternalInstallmentService": null, "interestTax": null } ] }, { "payment": { "id": 12, "name": "PayPal - 6U0DTI3M3OKO6R", "bin": null, "value": 10, "isDefault": false, "self": { "href": "/api/pvt/payment-systems/12" } }, "options": [ { "ruleId": "9ac0fa1b-dd9d-4549-abb8-e73bbb63c280", "quantity": 1, "value": 250.0, "interestRate": 0.0, "isExternalInstallmentService": null, "interestTax": null } ] } ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidRequestValue" }, "example": { "error": { "code": "1", "message": "Value must be greater than Zero", "exception": null } } } } } }, "deprecated": false } }, "/api/pvt/affiliations": { "servers": [ { "url": "https://{accountName}.vtexpayments.com.br", "description": "VTEX server URL.", "variables": { "accountName": { "description": "Name of the VTEX account. Used as part of the URL.", "default": "apiexamples" } } } ], "get": { "tags": [ "Configuration" ], "summary": "List all affiliations", "description": "Returns all affiliations (payment and anti-fraud providers) that are already configured in your store.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| PCI Gateway | Payment-Make Payments | **View Payment Data** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>\u2757 To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "operationId": "Affiliations", "parameters": [ { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" } ], "security": [ { "appKey": [], "appToken": [] }, { "VtexIdclientAutCookie": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "required": [ "id", "implementation", "name", "configuration", "isdelivered", "isConfigured" ], "items": { "type": "object", "description": "Affiliations information.", "properties": { "id": { "type": "string", "description": "Provider identification." }, "implementation": { "type": "string", "description": "Provider implementation class name." }, "name": { "type": "string", "description": "Provider name." }, "configuration": { "type": "array", "description": "Array containing configuration information fields.", "items": { "type": "object", "description": "Provider configuration information.", "required": [ "name", "value", "valueKey" ], "properties": { "name": { "type": "string", "description": "Configuration parameter name." }, "value": { "type": "string", "description": "Configuration parameter value.", "nullable": true }, "valueKey": { "type": "string", "description": "Value key information.", "nullable": true } } } }, "isdelivered": { "type": "boolean", "description": "Indicates whether the provider is published and available for use." }, "isConfigured": { "type": "boolean", "description": "Indicates whether the provider is configured." } } } }, "example": [ { "id": "c4c0d24d-b9b8-468d-af98-916b4ada930d", "implementation": "Vtex.PaymentGateway.Connectors.CieloV3Connector", "name": "CieloV3 - 3ds2 prod", "configuration": [ { "name": "HowTo", "value": "https://developercielo.github.io/payment-method-enablement/", "valueKey": null }, { "name": "MerchantId", "value": "56b93f46-2b3a-480f-8f9e-ec8e1fde97c0", "valueKey": null }, { "name": "MerchantKey", "value": "**********", "valueKey": null }, { "name": "softDescriptor", "value": "vtex test", "valueKey": null }, { "name": "bankInvoiceProvider", "value": "BancoDoBrasil2", "valueKey": null }, { "name": "bankDebitProvider", "value": "BancoDoBrasil", "valueKey": null }, { "name": "Registered", "value": "true", "valueKey": null }, { "name": "use3ds", "value": "true", "valueKey": null }, { "name": "EstablishmentCode", "value": "1119338171", "valueKey": null }, { "name": "MerchantName", "value": "VTEX", "valueKey": null }, { "name": "MCC", "value": "7372", "valueKey": null }, { "name": "ClientId", "value": "6b4853d7-44f8-4c58-8d48-811d4cb49e1a", "valueKey": null }, { "name": "ClientSecret", "value": "**********", "valueKey": null }, { "name": "BpmpiAuth", "value": "true", "valueKey": null }, { "name": "BpmpiAuthNotifyOnly", "value": "false", "valueKey": null }, { "name": "BpmpiAuthSuppresschallenge", "value": "false", "valueKey": null }, { "name": "useEarlySecurityCapture", "value": "0", "valueKey": null }, { "name": "autoSettleDelay", "value": "", "valueKey": null }, { "name": "isProduction", "value": "true", "valueKey": null } ], "isdelivered": true, "isConfigured": true }, { "id": "42bc3c4c-f8ca-4be0-870c-edfe263546b6", "implementation": "Vtex.PaymentGateway.Connectors.VtexGiftCardHub.VtexGiftCardHubConnector", "name": "Gift Card", "configuration": [ { "name": "usesOnlineRefund", "value": "true", "valueKey": null }, { "name": "useEarlySecurityCapture", "value": "1", "valueKey": null } ], "isdelivered": true, "isConfigured": true }, { "id": "1bd6e98e-6986-4ff3-ab58-78a37bd2a2ef", "implementation": "Vtex.PaymentGateway.Connectors.AdyenConnector", "name": "Adyen", "configuration": [ { "name": "username", "value": "ws_399958@Company.VtexBR", "valueKey": null }, { "name": "password", "value": "**********", "valueKey": null }, { "name": "account", "value": "VTEXPubliEventos", "valueKey": null }, { "name": "liveEndpointPrefix", "value": "99e86b1244882cda-VtexBR", "valueKey": null }, { "name": "marketPayAccount", "value": "", "valueKey": null }, { "name": "marketPayCommission", "value": "", "valueKey": null }, { "name": "subMerchantId", "value": "", "valueKey": null }, { "name": "Currency", "value": "BRL", "valueKey": null }, { "name": "Brand", "value": "boletobancario_bradesco", "valueKey": null }, { "name": "ShopperStatement", "value": "", "valueKey": null }, { "name": "SoftDescriptor", "value": "", "valueKey": null }, { "name": "SkinCode", "value": "", "valueKey": null }, { "name": "LanguageCode", "value": "pt", "valueKey": null }, { "name": "expirationDays", "value": "7", "valueKey": null }, { "name": "HmacKey", "value": "", "valueKey": null }, { "name": "useMultipleRefund", "value": "false", "valueKey": null }, { "name": "use3DS", "value": "true", "valueKey": null }, { "name": "threeDSecureMode", "value": "3ds2-auth", "valueKey": null }, { "name": "requireLiabilityShift", "value": "false", "valueKey": null }, { "name": "applePay_MerchantId", "value": "", "valueKey": null }, { "name": "applePay_MerchantCertificate", "value": null, "valueKey": null }, { "name": "applePay_MerchantPassword", "value": "", "valueKey": null }, { "name": "autoSettle", "value": "4", "valueKey": null }, { "name": "countryCode", "value": "AT", "valueKey": null }, { "name": "useEarlySecurityCapture", "value": "0", "valueKey": null }, { "name": "useAntifraud", "value": "false", "valueKey": null }, { "name": "isProduction", "value": "true", "valueKey": null }, { "name": "LinkHelp", "value": "", "valueKey": null } ], "isdelivered": true, "isConfigured": true }, { "id": "400b66d3-bc9a-4eb8-afc0-f32fe63c7121", "implementation": "Vtex.PaymentGateway.Connectors.BankIssuedInvoiceItauConnector", "name": "BankInvoice Itau", "configuration": [ { "name": "CompanyName", "value": "TESTE", "valueKey": null }, { "name": "Document", "value": "1111111111111111", "valueKey": null }, { "name": "BranchCode", "value": "1158", "valueKey": null }, { "name": "Account", "value": "1160", "valueKey": null }, { "name": "ExpiryDays", "value": "5", "valueKey": null }, { "name": "Instructions", "value": "xpto", "valueKey": null }, { "name": "Portfolio", "value": "11", "valueKey": null }, { "name": "BankAgreement", "value": "000111", "valueKey": null }, { "name": "TransferorCode", "value": "a", "valueKey": null }, { "name": "companyAddress", "value": "", "valueKey": null }, { "name": "Registered", "value": "true", "valueKey": null }, { "name": "configurationTemplate", "value": "{\"name\":\"Registered\",\"template\":[{\"value\":\"true\",\"configuration\":[{\"name\":\"AuthEnvironment\",\"hidden\":false},{\"name\":\"EnvironmentType\",\"hidden\":false},{\"name\":\"ClientId\",\"hidden\":false},{\"name\":\"ClientSecret\",\"hidden\":false},{\"name\":\"ItauKey\",\"hidden\":false}]}]}", "valueKey": null }, { "name": "AuthEnvironment", "value": "", "valueKey": null }, { "name": "EnvironmentType", "value": "", "valueKey": null }, { "name": "ClientId", "value": "", "valueKey": null }, { "name": "ClientSecret", "value": "", "valueKey": null }, { "name": "ItauKey", "value": "", "valueKey": null }, { "name": "TransactionExpirationDays", "value": "20", "valueKey": null }, { "name": "isProduction", "value": "true", "valueKey": null } ], "isdelivered": true, "isConfigured": true }, { "id": "1d884ffd-13d7-419e-a487-da55a2205792", "implementation": "Vtex.PaymentGateway.Connectors.TestConnector", "name": "Test Connector", "configuration": [ { "name": "OperationTime", "value": "1000", "valueKey": null }, { "name": "applePay_MerchantId", "value": "", "valueKey": null }, { "name": "applePay_MerchantCertificate", "value": null, "valueKey": null }, { "name": "applePay_MerchantPassword", "value": "", "valueKey": null }, { "name": "SamsungPayServiceId", "value": "", "valueKey": null } ], "isdelivered": false, "isConfigured": true } ] } } } }, "deprecated": false }, "post": { "tags": [ "Configuration" ], "summary": "Insert new affiliation", "description": "Registers a new affiliation (payment or anti-fraud provider) in your store.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| PCI Gateway | Payment-ManageStore | **Manage Store** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>\u2757 To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "operationId": "InsertAffiliation", "parameters": [ { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" } ], "security": [ { "appKey": [], "appToken": [] }, { "VtexIdclientAutCookie": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InsertAffiliationRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AffiliationResponse" }, "example": { "id": "fg8b4ea5-0b24-47dc-971e-2f6635ea1f14", "implementation": "Vtex.PaymentGateway.Connectors.CieloV3Connector", "name": "CieloV3 - Test", "configuration": [ { "name": "HowTo", "value": "https://developercielo.github.io/payment-method-enablement/", "valueKey": null }, { "name": "MerchantId", "value": "sampleData", "valueKey": null }, { "name": "MerchantKey", "value": "**********", "valueKey": null }, { "name": "softDescriptor", "value": "teste", "valueKey": null }, { "name": "bankInvoiceProvider", "value": "Disabled", "valueKey": null }, { "name": "bankIDebitProvider", "value": "Disabled", "valueKey": null }, { "name": "useEarlySecurityCapture", "value": "0", "valueKey": null }, { "name": "isProduction", "value": "false", "valueKey": null }, { "name": "bankDebitProvider", "value": "Disabled", "valueKey": null }, { "name": "Registered", "value": "false", "valueKey": null } ], "isdelivered": true, "isConfigured": true } } } } }, "deprecated": false } }, "/api/pvt/affiliations/{affiliationId}": { "servers": [ { "url": "https://{accountName}.vtexpayments.com.br", "description": "VTEX server URL.", "variables": { "accountName": { "description": "Name of the VTEX account. Used as part of the URL.", "default": "apiexamples" } } } ], "put": { "tags": [ "Configuration" ], "summary": "Update affiliation by ID", "description": "Updates information about an affiliation (payment or anti-fraud provider) configured in your store.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| PCI Gateway | Payment-ManageStore | **Manage Store** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>\u2757 To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "operationId": "UpdateAffiliation", "parameters": [ { "$ref": "#/components/parameters/affiliationId" }, { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" } ], "security": [ { "appKey": [], "appToken": [] }, { "VtexIdclientAutCookie": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAffiliationRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AffiliationResponse" }, "example": { "id": "fg8b4ea5-0b24-47dc-971e-2f6635ea1f14", "implementation": "Vtex.PaymentGateway.Connectors.CieloV3Connector", "name": "CieloV3 - Test", "configuration": [ { "name": "HowTo", "value": "https://developercielo.github.io/payment-method-enablement/", "valueKey": null }, { "name": "MerchantId", "value": "sampleData_2", "valueKey": null }, { "name": "MerchantKey", "value": "**********", "valueKey": null }, { "name": "softDescriptor", "value": "teste_update", "valueKey": null }, { "name": "bankInvoiceProvider", "value": "Disabled", "valueKey": null }, { "name": "bankIDebitProvider", "value": "Disabled", "valueKey": null }, { "name": "useEarlySecurityCapture", "value": "0", "valueKey": null }, { "name": "isProduction", "value": "false", "valueKey": null }, { "name": "bankDebitProvider", "value": "Disabled", "valueKey": null }, { "name": "Registered", "value": "false", "valueKey": null } ], "isdelivered": true, "isConfigured": true } } } } }, "deprecated": false }, "get": { "tags": [ "Configuration" ], "summary": "Get affiliation by ID", "description": "Returns data for a specific affiliation (payment or anti-fraud provider).\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| PCI Gateway | Payment-Make Payments | **View Payment Data** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>\u2757 To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "operationId": "AffiliationById", "parameters": [ { "$ref": "#/components/parameters/affiliationId" }, { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" } ], "security": [ { "appKey": [], "appToken": [] }, { "VtexIdclientAutCookie": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AffiliationResponse" }, "example": { "id": "fg8b4ea5-0b24-47dc-971e-2f6635ea1f14", "implementation": "Vtex.PaymentGateway.Connectors.CieloV3Connector", "name": "CieloV3 - Test", "configuration": [ { "name": "HowTo", "value": "https://developercielo.github.io/payment-method-enablement/", "valueKey": null }, { "name": "MerchantId", "value": "sampleData_2", "valueKey": null }, { "name": "MerchantKey", "value": "**********", "valueKey": null }, { "name": "softDescriptor", "value": "teste_update", "valueKey": null }, { "name": "bankInvoiceProvider", "value": "Disabled", "valueKey": null }, { "name": "bankIDebitProvider", "value": "Disabled", "valueKey": null }, { "name": "useEarlySecurityCapture", "value": "0", "valueKey": null }, { "name": "isProduction", "value": "false", "valueKey": null }, { "name": "bankDebitProvider", "value": "Disabled", "valueKey": null }, { "name": "Registered", "value": "false", "valueKey": null } ], "isdelivered": true, "isConfigured": true } } } } }, "deprecated": false } }, "/api/pvt/rules": { "servers": [ { "url": "https://{accountName}.vtexpayments.com.br", "description": "VTEX server URL.", "variables": { "accountName": { "description": "Name of the VTEX account. Used as part of the URL.", "default": "apiexamples" } } } ], "get": { "tags": [ "Configuration" ], "summary": "List all payment rules", "description": "Returns all payment rules applied to the payment providers configured in your store.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| PCI Gateway | Payment-Make Payments | **View Payment Data** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>\u2757 To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "operationId": "Rules", "parameters": [ { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" } ], "security": [ { "appKey": [], "appToken": [] }, { "VtexIdclientAutCookie": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetRulesResponse" }, "example": [ { "id": "9e11ed95-4b7f-4445-a53e-2512f260ff1c", "name": "American Express - ", "salesChannels": [ { "id": ":ALL:" } ], "paymentSystem": { "id": 1, "name": "American Express", "implementation": null }, "connector": { "implementation": "Vtex.PaymentGateway.Connectors.AuthorizeDotNet.AuthorizeDotNetConnector", "affiliationId": "08a0844b-4aab-4f1b-beed-b3889649534b" }, "issuer": { "name": null }, "antifraud": { "implementation": null, "affiliationId": null }, "installmentOptions": { "dueDateType": 0, "interestRateMethod": 0, "minimumInstallmentValue": 1.0, "installments": [ { "ruleId": null, "quantity": 12, "value": 0.0, "interestRate": 1.86, "isExternalInstallmentService": null, "interestTax": 0.0 }, { "ruleId": null, "quantity": 18, "value": 0.0, "interestRate": 1.9, "isExternalInstallmentService": null, "interestTax": 0.0 } ] }, "isSelfAuthorized": null, "requiresAuthentication": null, "enabled": true, "installmentsService": false, "isDefault": null, "beginDate": "2023-12-10T17:00:00Z", "endDate": "2023-12-22T01:00:00Z", "condition": { "id": "1", "pullRate": 0.0, "name": null }, "multiMerchantList": [ "test_store_1", "test_store_2" ], "country": { "name": null, "isoCode": "us" }, "dateIntervals": [ { "start": "* * 11 * * 1,3,4 * -0300", "end": "* * 18 * * 1,3,4 * -0300" }, { "start": "* * 05 * * * * -0300", "end": "* * 23 * * * * -0300" } ], "externalInterest": false, "minimumValue": null, "deadlines": [], "cobrand": { "name": null }, "cardLevel": { "name": "Premium" }, "excludedBinsRanges": null }, { "id": "01a8d68b-9116-4655-83f8-3380f658ec04", "name": "QR Code", "salesChannels": [ { "id": ":ALL:" } ], "paymentSystem": { "id": 72, "name": "PicPay", "implementation": null }, "connector": { "implementation": "Vtex.PaymentGateway.Connectors.PaymentProvider.PaymentProviderConnector_PicPay", "affiliationId": "9c4e7bb1-0356-4449-b59f-2e1bbac606f8" }, "issuer": { "name": null }, "antifraud": { "implementation": null, "affiliationId": null }, "installmentOptions": { "dueDateType": 1, "interestRateMethod": 0, "minimumInstallmentValue": 10.0, "installments": [ { "ruleId": null, "quantity": 1, "value": 0.0, "interestRate": 0.0, "isExternalInstallmentService": null, "interestTax": 0.0 }, { "ruleId": null, "quantity": 2, "value": 0.0, "interestRate": 0.0, "isExternalInstallmentService": null, "interestTax": 0.0 }, { "ruleId": null, "quantity": 3, "value": 0.0, "interestRate": 0.0, "isExternalInstallmentService": null, "interestTax": 0.0 }, { "ruleId": null, "quantity": 4, "value": 0.0, "interestRate": 0.0, "isExternalInstallmentService": null, "interestTax": 0.0 } ] }, "isSelfAuthorized": null, "requiresAuthentication": null, "enabled": true, "installmentsService": false, "isDefault": null, "beginDate": null, "endDate": null, "condition": null, "multiMerchantList": null, "country": null, "dateIntervals": null, "externalInterest": false, "minimumValue": null, "deadlines": [], "cobrand": { "name": null }, "cardLevel": { "name": null }, "excludedBinsRanges": null }, { "id": "38426c64-fb35-412c-9900-c3fc0e812109", "name": "Customer Credit - ", "salesChannels": [ { "id": ":ALL:" } ], "paymentSystem": { "id": 64, "name": "Customer Credit", "implementation": null }, "connector": { "implementation": "Vtex.PaymentGateway.Connectors.PaymentProvider.PaymentProviderConnector_CreditControlV2", "affiliationId": "7f95a993-4a8c-4d08-a1ae-94625ff1bfb4" }, "issuer": { "name": null }, "antifraud": { "implementation": null, "affiliationId": null }, "installmentOptions": { "dueDateType": 0, "interestRateMethod": 0, "minimumInstallmentValue": 0.0, "installments": [ { "ruleId": null, "quantity": 1, "value": 0.0, "interestRate": 0.0, "isExternalInstallmentService": null, "interestTax": null }, { "ruleId": null, "quantity": 2, "value": 0.0, "interestRate": 0.0, "isExternalInstallmentService": null, "interestTax": null } ] }, "isSelfAuthorized": null, "requiresAuthentication": null, "enabled": true, "installmentsService": false, "isDefault": null, "beginDate": null, "endDate": null, "condition": null, "multiMerchantList": null, "country": null, "dateIntervals": [ { "start": "* * 11 * * 1,3,4 * -0300", "end": "* * 18 * * 1,3,4 * -0300" }, { "start": "* * 05 * * * * -0300", "end": "* * 23 * * * * -0300" } ], "externalInterest": false, "minimumValue": null, "deadlines": [ { "paymentOptions": [ { "days": 30, "interestRate": 0.0 } ] }, { "paymentOptions": [ { "days": 30, "interestRate": 0.0 }, { "days": 60, "interestRate": 0.0 } ] }, { "paymentOptions": [ { "days": 15, "interestRate": 0.0 }, { "days": 30, "interestRate": 0.0 } ] } ], "cobrand": { "name": null }, "cardLevel": { "name": null }, "excludedBinsRanges": null }, { "id": "b7137b64-5b45-4c03-8d75-5ebc320fe537", "name": "Cash on Delivery", "salesChannels": [ { "id": ":ALL:" } ], "paymentSystem": { "id": 17, "name": "Promissory", "implementation": null }, "connector": { "implementation": "Vtex.PaymentGateway.Connectors.PromissoryConnector", "affiliationId": "914a05f6-f48f-4dc1-a41d-ffe3f682b405" }, "issuer": { "name": null }, "antifraud": { "implementation": null, "affiliationId": null }, "installmentOptions": null, "isSelfAuthorized": null, "requiresAuthentication": null, "enabled": true, "installmentsService": false, "isDefault": null, "beginDate": null, "endDate": null, "condition": { "id": "1", "pullRate": 1.0, "name": null }, "multiMerchantList": null, "country": null, "dateIntervals": null, "externalInterest": false, "minimumValue": null, "deadlines": [], "cobrand": { "name": null }, "cardLevel": { "name": null }, "excludedBinsRanges": null }, { "id": "46a75262-6666-43d8-bff5-b6b439a5e074", "name": "Maestro - ", "salesChannels": [ { "id": ":ALL:" } ], "paymentSystem": { "id": 39, "name": "Maestro", "implementation": null }, "connector": { "implementation": "Vtex.PaymentGateway.Connectors.AdyenConnector", "affiliationId": "1bd6e98e-6986-4ff3-ab58-78a37bd2a2ef" }, "issuer": { "name": null }, "antifraud": { "implementation": null, "affiliationId": null }, "installmentOptions": null, "isSelfAuthorized": null, "requiresAuthentication": null, "enabled": true, "installmentsService": false, "isDefault": null, "beginDate": null, "endDate": null, "condition": null, "multiMerchantList": null, "country": null, "dateIntervals": null, "externalInterest": false, "minimumValue": null, "deadlines": [], "cobrand": { "name": null }, "cardLevel": { "name": null }, "excludedBinsRanges": null }, { "id": "453cb507-294c-40c4-84d3-49ecb02acbbb", "name": "Visa - ", "salesChannels": [ { "id": ":ALL:" } ], "paymentSystem": { "id": 2, "name": "Visa", "implementation": null }, "connector": { "implementation": "Vtex.PaymentGateway.Connectors.MercadoPagoV1.MercadoPagoV1Connector", "affiliationId": "37806301-73da-4c3f-96e8-7b00fde5fbf2" }, "issuer": { "name": null }, "antifraud": { "implementation": null, "affiliationId": null }, "installmentOptions": null, "isSelfAuthorized": null, "requiresAuthentication": null, "enabled": false, "installmentsService": false, "isDefault": null, "beginDate": null, "endDate": null, "condition": null, "multiMerchantList": null, "country": null, "dateIntervals": null, "externalInterest": false, "minimumValue": null, "deadlines": [], "cobrand": { "name": null }, "cardLevel": { "name": null }, "excludedBinsRanges": null }, { "id": "c6a4675f-a3eb-441a-9de0-75e3b784af7b", "name": "Mastercard - ", "salesChannels": [ { "id": ":ALL:" } ], "paymentSystem": { "id": 4, "name": "Mastercard", "implementation": null }, "connector": { "implementation": "Vtex.PaymentGateway.Connectors.AuthorizeDotNet.AuthorizeDotNetConnector", "affiliationId": "08a0844b-4aab-4f1b-beed-b3889649534b" }, "issuer": { "name": null }, "antifraud": { "implementation": null, "affiliationId": null }, "installmentOptions": null, "isSelfAuthorized": null, "requiresAuthentication": null, "enabled": false, "installmentsService": false, "isDefault": null, "beginDate": null, "endDate": null, "condition": null, "multiMerchantList": null, "country": null, "dateIntervals": null, "externalInterest": false, "minimumValue": null, "deadlines": [], "cobrand": { "name": null }, "cardLevel": { "name": null }, "excludedBinsRanges": null }, { "id": "df391a06-e6de-4fbf-ae8f-fd40fecba88f", "name": "Bank Invoice - ", "salesChannels": [ { "id": ":ALL:" } ], "paymentSystem": { "id": 6, "name": "Bank Invoice", "implementation": null }, "connector": { "implementation": "Vtex.PaymentGateway.Connectors.TestConnector", "affiliationId": "1d884ffd-13d7-419e-a487-da55a2205792" }, "issuer": { "name": null }, "antifraud": { "implementation": null, "affiliationId": null }, "installmentOptions": null, "isSelfAuthorized": null, "requiresAuthentication": null, "enabled": false, "installmentsService": false, "isDefault": null, "beginDate": null, "endDate": null, "condition": null, "multiMerchantList": null, "country": null, "dateIntervals": null, "externalInterest": false, "minimumValue": null, "deadlines": [], "cobrand": { "name": null }, "cardLevel": { "name": null }, "excludedBinsRanges": null }, { "id": "220c353e-a298-4f87-ace8-fb4909d34248", "name": "Google Pay - ", "salesChannels": [ { "id": ":ALL:" } ], "paymentSystem": { "id": 169, "name": "Google Pay", "implementation": null }, "connector": { "implementation": "Vtex.PaymentGateway.Connectors.PaymentProvider.PaymentProviderConnector_stripe-payment-provider-connector-v3", "affiliationId": "d983efd2-93ee-46ad-857f-39f933ffdf03" }, "issuer": { "name": null }, "antifraud": { "implementation": null, "affiliationId": null }, "installmentOptions": null, "isSelfAuthorized": null, "requiresAuthentication": null, "enabled": true, "installmentsService": false, "isDefault": null, "beginDate": null, "endDate": null, "condition": null, "multiMerchantList": null, "country": null, "dateIntervals": null, "externalInterest": false, "minimumValue": null, "deadlines": [], "cobrand": { "name": null }, "cardLevel": { "name": null }, "excludedBinsRanges": null }, { "id": "f1442584-f627-4766-a878-dd9427c2cd4b", "name": "Invoice Payment App", "salesChannels": [ { "id": ":ALL:" } ], "paymentSystem": { "id": 6, "name": "Boleto Bancário", "implementation": null }, "connector": { "implementation": "Vtex.PaymentGateway.Connectors.BankIssuedInvoiceItauConnector", "affiliationId": "400b66d3-bc9a-4eb8-afc0-f32fe63c7121" }, "issuer": { "name": null }, "antifraud": { "implementation": null, "affiliationId": null }, "installmentOptions": null, "isSelfAuthorized": null, "requiresAuthentication": null, "enabled": false, "installmentsService": false, "isDefault": null, "beginDate": null, "endDate": null, "condition": null, "multiMerchantList": null, "country": null, "dateIntervals": null, "externalInterest": false, "minimumValue": null, "deadlines": [], "cobrand": { "name": null }, "cardLevel": { "name": null }, "excludedBinsRanges": null }, { "id": "16641c21-d94a-4c0c-9bfa-fb7d646b495f", "name": "Pix - ", "salesChannels": [ { "id": ":ALL:" } ], "paymentSystem": { "id": 125, "name": "Pix", "implementation": null }, "connector": { "implementation": "Vtex.PaymentGateway.Connectors.PaymentProvider.PaymentProviderConnector_SpinPay", "affiliationId": "268d2e68-169a-4a85-a670-39409a2a24b6" }, "issuer": { "name": null }, "antifraud": { "implementation": null, "affiliationId": null }, "installmentOptions": null, "isSelfAuthorized": null, "requiresAuthentication": null, "enabled": false, "installmentsService": false, "isDefault": null, "beginDate": null, "endDate": null, "condition": null, "multiMerchantList": null, "country": null, "dateIntervals": null, "externalInterest": false, "minimumValue": null, "deadlines": [], "cobrand": { "name": null }, "cardLevel": { "name": null }, "excludedBinsRanges": null } ] } } } }, "deprecated": false }, "post": { "tags": [ "Configuration" ], "summary": "Insert a new payment rule", "description": "Creates a new payment rule to be applied to the payment providers configured in your store.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| PCI Gateway | Payment-ManageStore | **Manage Store** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>\u2757 To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "operationId": "InsertRule", "parameters": [ { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" } ], "security": [ { "appKey": [], "appToken": [] }, { "VtexIdclientAutCookie": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InsertRuleRequest" }, "example": { "name": "Test_API_2", "salesChannels": [ { "id": "1" } ], "paymentSystem": { "id": 8, "name": "Hipercard", "implementation": null }, "connector": { "implementation": "Vtex.PaymentGateway.Connectors.CieloV3Connector", "affiliationId": "0a8488e6-0c30-4150-be96-b0dcaaa6a0cd" }, "issuer": { "name": "barclays" }, "antifraud": { "implementation": null, "affiliationId": null }, "installmentOptions": { "dueDateType": 1, "interestRateMethod": 2, "minimumInstallmentValue": 50.0, "installments": [ { "ruleId": null, "quantity": 6, "value": 0.0, "interestRate": 15.0, "isExternalInstallmentService": null, "interestTax": 0.0 } ] }, "isSelfAuthorized": null, "requiresAuthentication": null, "enabled": false, "installmentsService": false, "isDefault": null, "beginDate": "2023-12-10T17:00:00Z", "endDate": "2023-12-22T01:00:00Z", "condition": { "id": "1", "pullRate": 0.0, "name": null }, "multiMerchantList": [ "cosmetics2" ], "country": { "name": null, "isoCode": "us" }, "dateIntervals": [ { "start": "* * 11 * * 1,3,4 * -0300", "end": "* * 18 * * 1,3,4 * -0300" }, { "start": "* * 05 * * * * -0300", "end": "* * 23 * * * * -0300" } ], "externalInterest": false, "minimumValue": null, "deadlines": [], "cobrand": { "name": null }, "cardLevel": { "name": "business" }, "excludedBinsRanges": null } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RulesRequest" }, "example": { "id": "c997267e-39bf-4217-a890-a503f6a7dc47", "name": "Test_API_2", "salesChannels": [ { "id": "1" } ], "paymentSystem": { "id": 8, "name": "Hipercard", "implementation": null }, "connector": { "implementation": "Vtex.PaymentGateway.Connectors.CieloV3Connector", "affiliationId": "0a8488e6-0c30-4150-be96-b0dcaaa6a0cd" }, "issuer": { "name": "barclays" }, "antifraud": null, "installmentOptions": { "dueDateType": 1, "interestRateMethod": 2, "minimumInstallmentValue": 50.0, "installments": [ { "ruleId": null, "quantity": 6, "value": 0.0, "interestRate": 15.0, "isExternalInstallmentService": null, "interestTax": 0.0 } ] }, "isSelfAuthorized": null, "requiresAuthentication": null, "enabled": false, "installmentsService": false, "isDefault": null, "beginDate": "2023-12-10T17:00:00Z", "endDate": "2023-12-22T01:00:00Z", "condition": { "id": "1", "pullRate": 0.0, "name": null }, "multiMerchantList": [ "cosmetics2" ], "country": { "name": null, "isoCode": "us" }, "dateIntervals": [ { "start": "* * 11 * * 1,3,4 * -0300", "end": "* * 18 * * 1,3,4 * -0300" }, { "start": "* * 05 * * * * -0300", "end": "* * 23 * * * * -0300" } ], "externalInterest": false, "minimumValue": null, "deadlines": [], "cobrand": { "name": null }, "cardLevel": { "name": "business" }, "excludedBinsRanges": null } } } } }, "deprecated": false } }, "/api/pvt/rules/{ruleId}": { "servers": [ { "url": "https://{accountName}.vtexpayments.com.br", "description": "VTEX server URL.", "variables": { "accountName": { "description": "Name of the VTEX account. Used as part of the URL.", "default": "apiexamples" } } } ], "get": { "tags": [ "Configuration" ], "summary": "Get payment rule by ID", "description": "Returns data for a specific payment rule applied to the payment providers configured in your store.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| PCI Gateway | Payment-Make Payments | **View Payment Data** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>\u2757 To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "operationId": "RuleById", "parameters": [ { "$ref": "#/components/parameters/ruleId" }, { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" } ], "security": [ { "appKey": [], "appToken": [] }, { "VtexIdclientAutCookie": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RulesRequest" }, "example": { "id": "9e11ed95-4b7f-4445-a53e-2512f260ff1c", "name": "American Express - ", "salesChannels": [ { "id": ":ALL:" } ], "paymentSystem": { "id": 1, "name": "American Express", "implementation": null }, "connector": { "implementation": "Vtex.PaymentGateway.Connectors.AuthorizeDotNet.AuthorizeDotNetConnector", "affiliationId": "08a0844b-4aab-4f1b-beed-b3889649534b" }, "issuer": { "name": null }, "antifraud": { "implementation": null, "affiliationId": null }, "installmentOptions": { "dueDateType": 0, "interestRateMethod": 0, "minimumInstallmentValue": 1.0, "installments": [ { "ruleId": null, "quantity": 12, "value": 0.0, "interestRate": 1.86, "isExternalInstallmentService": null, "interestTax": 0.0 }, { "ruleId": null, "quantity": 18, "value": 0.0, "interestRate": 1.9, "isExternalInstallmentService": null, "interestTax": 0.0 } ] }, "isSelfAuthorized": null, "requiresAuthentication": null, "enabled": true, "installmentsService": false, "isDefault": null, "beginDate": "2023-12-10T17:00:00Z", "endDate": "2023-12-22T01:00:00Z", "condition": { "id": "1", "pullRate": 0.0, "name": null }, "multiMerchantList": [ "test_store_1", "test_store_2" ], "country": { "name": null, "isoCode": "us" }, "dateIntervals": [ { "start": "* * 11 * * 1,3,4 * -0300", "end": "* * 18 * * 1,3,4 * -0300" }, { "start": "* * 05 * * * * -0300", "end": "* * 23 * * * * -0300" } ], "externalInterest": false, "minimumValue": null, "deadlines": [], "cobrand": { "name": null }, "cardLevel": { "name": "Premium" }, "excludedBinsRanges": null } } } } }, "deprecated": false }, "put": { "tags": [ "Configuration" ], "summary": "Update payment rule by ID", "description": "Updates information about a specific payment rule applied to the payment providers configured in your store.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| PCI Gateway | Payment-ManageStore | **Manage Store** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>\u2757 To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "operationId": "PutRuleById", "parameters": [ { "$ref": "#/components/parameters/ruleId" }, { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" } ], "security": [ { "appKey": [], "appToken": [] }, { "VtexIdclientAutCookie": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RulesRequest" }, "example": { "id": "c997267e-39bf-4217-a890-a503f6a7dc47", "name": "Test_API_2_Updated", "salesChannels": [ { "id": "1" } ], "paymentSystem": { "id": 8, "name": "Hipercard", "implementation": null }, "connector": { "implementation": "Vtex.PaymentGateway.Connectors.CieloV3Connector", "affiliationId": "0a8488e6-0c30-4150-be96-b0dcaaa6a0cd" }, "issuer": { "name": "barclays" }, "antifraud": null, "installmentOptions": { "dueDateType": 0, "interestRateMethod": 1, "minimumInstallmentValue": 400.0, "installments": [ { "ruleId": null, "quantity": 12, "value": 0.0, "interestRate": 25.0, "isExternalInstallmentService": null, "interestTax": 0.0 } ] }, "isSelfAuthorized": null, "requiresAuthentication": null, "enabled": false, "installmentsService": false, "isDefault": null, "beginDate": "2023-12-15T17:00:00Z", "endDate": "2023-12-30T01:00:00Z", "condition": { "id": "1", "pullRate": 15.0, "name": null }, "multiMerchantList": [], "country": { "name": null, "isoCode": "br" }, "dateIntervals": [ { "start": "* * 12 * * 1,3,4 * -0300", "end": "* * 19 * * 1,3,4 * -0300" }, { "start": "* * 09 * * * * -0300", "end": "* * 21 * * * * -0300" } ], "externalInterest": false, "minimumValue": null, "deadlines": [], "cobrand": { "name": null }, "cardLevel": { "name": "gold" }, "excludedBinsRanges": null } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RulesRequest" }, "example": { "id": "c997267e-39bf-4217-a890-a503f6a7dc47", "name": "Test_API_2_Updated", "salesChannels": [ { "id": "1" } ], "paymentSystem": { "id": 8, "name": "Hipercard", "implementation": null }, "connector": { "implementation": "Vtex.PaymentGateway.Connectors.CieloV3Connector", "affiliationId": "0a8488e6-0c30-4150-be96-b0dcaaa6a0cd" }, "issuer": { "name": "barclays" }, "antifraud": null, "installmentOptions": { "dueDateType": 0, "interestRateMethod": 1, "minimumInstallmentValue": 400.0, "installments": [ { "ruleId": null, "quantity": 12, "value": 0.0, "interestRate": 25.0, "isExternalInstallmentService": null, "interestTax": 0.0 } ] }, "isSelfAuthorized": null, "requiresAuthentication": null, "enabled": false, "installmentsService": false, "isDefault": null, "beginDate": "2023-12-15T17:00:00Z", "endDate": "2023-12-30T01:00:00Z", "condition": { "id": "1", "pullRate": 15.0, "name": null }, "multiMerchantList": [], "country": { "name": null, "isoCode": "br" }, "dateIntervals": [ { "start": "* * 12 * * 1,3,4 * -0300", "end": "* * 19 * * 1,3,4 * -0300" }, { "start": "* * 09 * * * * -0300", "end": "* * 21 * * * * -0300" } ], "externalInterest": false, "minimumValue": null, "deadlines": [], "cobrand": { "name": null }, "cardLevel": { "name": "gold" }, "excludedBinsRanges": null } } } } }, "deprecated": false }, "delete": { "tags": [ "Configuration" ], "summary": "Delete payment rule by ID", "description": "Deletes a specific payment rule applied to the payment providers configured in your store.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| PCI Gateway | Payment-ManageStore | **Manage Store** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>\u2757 To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "operationId": "Rule", "parameters": [ { "$ref": "#/components/parameters/ruleId" }, { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" } ], "security": [ { "appKey": [], "appToken": [] }, { "VtexIdclientAutCookie": [] } ], "responses": { "200": { "description": "OK. This endpoint does not return any data in the response body." } }, "deprecated": false } }, "/api/pvt/merchants/payment-systems": { "servers": [ { "url": "https://{accountName}.vtexpayments.com.br", "description": "VTEX server URL.", "variables": { "accountName": { "description": "Name of the VTEX account. Used as part of the URL.", "default": "apiexamples" } } } ], "get": { "tags": [ "Configuration" ], "summary": "List all available payment methods", "description": "Returns all payment methods (such as Visa, Master, among others) that can be used in your store.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| PCI Gateway | Payment-Make Payments | **View Payment Data** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>\u2757 To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "operationId": "AvailablePaymentMethods", "parameters": [ { "name": "salesChannel", "in": "query", "description": "Sales channel ([trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) identification. This parameter must be filled in if you wish to obtain information on payment methods available in a specific store sales channel.", "required": false, "style": "form", "schema": { "type": "integer", "example": 1 } }, { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" } ], "security": [ { "appKey": [], "appToken": [] }, { "VtexIdclientAutCookie": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "description": "Payment methods information.", "items": { "$ref": "#/components/schemas/PaymentSystemsResponse" } }, "example": [ { "id": 1, "name": "American Express", "requiresDocument": false, "implementation": "Vtex.PaymentGateway.CreditCard.Amex", "connectorImplementation": "Vtex.PaymentGateway.Connectors.AuthorizeDotNet.AuthorizeDotNetConnector", "antifraudConnectorImplementation": null, "groupName": "creditCard", "redirect": false, "isCustom": false, "isSelfAuthorized": false, "requiresAuthentication": false, "allowInstallments": true, "allowBinExclusion": false, "allowMultiple": true, "allowIssuer": true, "allowCountry": false, "allowCommercialPolicy": true, "allowCommercialCondition": true, "allowPeriod": true, "isAvailable": true, "description": null, "supportRecurrence": true, "validator": { "regex": "^3[47][0-9]{13}$", "mask": "9999 999999 99999", "cardCodeMask": "9999", "cardCodeRegex": "^[0-9]{4}$", "weights": [ 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1 ], "useCvv": true, "useExpirationDate": true, "useCardHolderName": true, "useBillingAddress": true, "validCardLengths": null }, "appDependencies": null, "displayDocument": false, "dueDate": "2023-12-20T11:46:27.2993428Z", "allowNotification": false, "affiliationId": null, "availablePayments": null, "dueDateMinutes": 10079 }, { "id": 72, "name": "PicPay", "requiresDocument": false, "implementation": "Vtex.PaymentGateway.RedirectPayments.PicPayPayment", "connectorImplementation": "Vtex.PaymentGateway.Connectors.PaymentProvider.PaymentProviderConnector_PicPay", "antifraudConnectorImplementation": null, "groupName": "picPay", "redirect": true, "isCustom": false, "isSelfAuthorized": false, "requiresAuthentication": false, "allowInstallments": true, "allowBinExclusion": false, "allowMultiple": true, "allowIssuer": false, "allowCountry": true, "allowCommercialPolicy": true, "allowCommercialCondition": true, "allowPeriod": true, "isAvailable": true, "description": null, "supportRecurrence": false, "validator": { "regex": null, "mask": null, "cardCodeMask": null, "cardCodeRegex": null, "weights": null, "useCvv": false, "useExpirationDate": false, "useCardHolderName": false, "useBillingAddress": false, "validCardLengths": null }, "appDependencies": null, "displayDocument": false, "dueDate": "2023-12-20T11:46:27.2993428Z", "allowNotification": false, "affiliationId": null, "availablePayments": null, "dueDateMinutes": 10079 }, { "id": 64, "name": "Customer Credit", "requiresDocument": false, "implementation": "Vtex.PaymentGateway.Promissory.CreditControlPayment", "connectorImplementation": "Vtex.PaymentGateway.Connectors.PaymentProvider.PaymentProviderConnector_CreditControlV2", "antifraudConnectorImplementation": null, "groupName": "creditControl", "redirect": false, "isCustom": false, "isSelfAuthorized": false, "requiresAuthentication": false, "allowInstallments": true, "allowBinExclusion": false, "allowMultiple": true, "allowIssuer": false, "allowCountry": false, "allowCommercialPolicy": true, "allowCommercialCondition": true, "allowPeriod": true, "isAvailable": true, "description": null, "supportRecurrence": false, "validator": { "regex": null, "mask": null, "cardCodeMask": null, "cardCodeRegex": null, "weights": null, "useCvv": false, "useExpirationDate": false, "useCardHolderName": false, "useBillingAddress": false, "validCardLengths": null }, "appDependencies": null, "displayDocument": false, "dueDate": "2023-12-20T11:46:27.2993428Z", "allowNotification": false, "affiliationId": null, "availablePayments": null, "dueDateMinutes": 10079 }, { "id": 16, "name": "Vale", "requiresDocument": true, "implementation": "Vtex.PaymentGateway.GiftCard.VtexGiftCard", "connectorImplementation": "Vtex.PaymentGateway.Connectors.VtexGiftCardHub.VtexGiftCardHubConnector", "antifraudConnectorImplementation": null, "groupName": "giftCard", "redirect": false, "isCustom": false, "isSelfAuthorized": false, "requiresAuthentication": false, "allowInstallments": false, "allowBinExclusion": false, "allowMultiple": true, "allowIssuer": false, "allowCountry": false, "allowCommercialPolicy": true, "allowCommercialCondition": true, "allowPeriod": true, "isAvailable": true, "description": null, "supportRecurrence": false, "validator": { "regex": null, "mask": null, "cardCodeMask": null, "cardCodeRegex": null, "weights": null, "useCvv": false, "useExpirationDate": false, "useCardHolderName": false, "useBillingAddress": false, "validCardLengths": null }, "appDependencies": null, "displayDocument": true, "dueDate": "2023-12-20T11:46:27.2993428Z", "allowNotification": false, "affiliationId": null, "availablePayments": null, "dueDateMinutes": 10079 }, { "id": 39, "name": "Maestro", "requiresDocument": false, "implementation": "Vtex.PaymentGateway.Card.Maestro", "connectorImplementation": "Vtex.PaymentGateway.Connectors.AdyenConnector", "antifraudConnectorImplementation": null, "groupName": "debitCard", "redirect": false, "isCustom": false, "isSelfAuthorized": false, "requiresAuthentication": false, "allowInstallments": false, "allowBinExclusion": false, "allowMultiple": false, "allowIssuer": true, "allowCountry": false, "allowCommercialPolicy": true, "allowCommercialCondition": true, "allowPeriod": true, "isAvailable": true, "description": null, "supportRecurrence": false, "validator": { "regex": "^((5(([1-2]|[4-5])[0-9]{8}|0((1|6)([0-9]{7}))|3(0(4((0|[2-9])[0-9]{5})|([0-3]|[5-9])[0-9]{6})|[1-9][0-9]{7})))|((508116)\\d{4,10})|((502121)\\d{4,10})|((589916)\\d{4,10})|(2[0-9]{15})|(67[0-9]{14})|(506387)\\d{4,10})", "mask": "9999 9999 9999 9999", "cardCodeMask": "999", "cardCodeRegex": "^[0-9]{3}$", "weights": [ 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2 ], "useCvv": true, "useExpirationDate": true, "useCardHolderName": true, "useBillingAddress": true, "validCardLengths": null }, "appDependencies": null, "displayDocument": false, "dueDate": "2023-12-20T11:46:27.2993428Z", "allowNotification": false, "affiliationId": null, "availablePayments": null, "dueDateMinutes": 10079 }, { "id": 169, "name": "Google Pay", "requiresDocument": false, "implementation": "Vtex.PaymentGateway.RedirectPayments.GooglePayPayment", "connectorImplementation": "Vtex.PaymentGateway.Connectors.PaymentProvider.PaymentProviderConnector_stripe-payment-provider-connector-v3", "antifraudConnectorImplementation": null, "groupName": "Google Pay", "redirect": true, "isCustom": false, "isSelfAuthorized": false, "requiresAuthentication": false, "allowInstallments": false, "allowBinExclusion": false, "allowMultiple": true, "allowIssuer": false, "allowCountry": true, "allowCommercialPolicy": true, "allowCommercialCondition": true, "allowPeriod": true, "isAvailable": true, "description": null, "supportRecurrence": false, "validator": { "regex": null, "mask": null, "cardCodeMask": null, "cardCodeRegex": null, "weights": null, "useCvv": false, "useExpirationDate": false, "useCardHolderName": false, "useBillingAddress": false, "validCardLengths": null }, "appDependencies": null, "displayDocument": false, "dueDate": "2023-12-20T11:46:27.2993428Z", "allowNotification": false, "affiliationId": null, "availablePayments": null, "dueDateMinutes": 10079 }, { "id": 4, "name": "Mastercard", "requiresDocument": true, "implementation": "Vtex.PaymentGateway.CreditCard.Mastercard", "connectorImplementation": "Vtex.PaymentGateway.Connectors.PaymentProvider.PaymentProviderConnector_cosmetics2-payment-provider-v0", "antifraudConnectorImplementation": null, "groupName": "creditCard", "redirect": false, "isCustom": false, "isSelfAuthorized": false, "requiresAuthentication": false, "allowInstallments": true, "allowBinExclusion": false, "allowMultiple": true, "allowIssuer": true, "allowCountry": false, "allowCommercialPolicy": true, "allowCommercialCondition": true, "allowPeriod": true, "isAvailable": true, "description": null, "supportRecurrence": true, "validator": { "regex": "^((5(([1-2]|[4-5])[0-9]{8}|0((1|6)([0-9]{7}))|3(0(4((0|[2-9])[0-9]{5})|([0-3]|[5-9])[0-9]{6})|[1-9][0-9]{7})))|((508116)\\d{4,10})|((502121)\\d{4,10})|((589916)\\d{4,10})|(2[0-9]{15})|(67[0-9]{14})|(506387)\\d{4,10})", "mask": "9999 9999 9999 9999", "cardCodeMask": "999", "cardCodeRegex": "^[0-9]{3}$", "weights": [ 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2 ], "useCvv": true, "useExpirationDate": true, "useCardHolderName": true, "useBillingAddress": true, "validCardLengths": null }, "appDependencies": null, "displayDocument": true, "dueDate": "2023-12-20T11:46:27.2993428Z", "allowNotification": false, "affiliationId": null, "availablePayments": null, "dueDateMinutes": 10079 }, { "id": 401, "name": "PaymentApp", "requiresDocument": false, "implementation": "Vtex.PaymentGateway.CreditCard.PrivateLabelPayment", "connectorImplementation": "Vtex.PaymentGateway.Connectors.PaymentProvider.PaymentProviderConnector_cosmetics2-payment-provider-v0", "antifraudConnectorImplementation": null, "groupName": "customPrivate_401", "redirect": false, "isCustom": true, "isSelfAuthorized": false, "requiresAuthentication": false, "allowInstallments": true, "allowBinExclusion": false, "allowMultiple": true, "allowIssuer": true, "allowCountry": false, "allowCommercialPolicy": true, "allowCommercialCondition": true, "allowPeriod": true, "isAvailable": true, "description": "", "supportRecurrence": true, "validator": { "regex": "1(0(0(0(0([0-9])|[1-9][0-9]{11})|[1-9][0-9]{12})|[1-9][0-9]{13})|[1-9][0-9]{14})|9(9(9(9(9([0-9])|[0-8][0-9]{11})|[0-8][0-9]{12})|[0-8][0-9]{13})|[0-8][0-9]{14})|[2-8][0-9]{15}", "mask": "9999 9999 9999 9999", "cardCodeMask": "999", "cardCodeRegex": "^[0-9]{3}$", "weights": [], "useCvv": true, "useExpirationDate": true, "useCardHolderName": true, "useBillingAddress": false, "validCardLengths": null }, "appDependencies": null, "displayDocument": false, "dueDate": "2023-12-23T11:46:27.2993428Z", "allowNotification": false, "affiliationId": null, "availablePayments": null, "dueDateMinutes": 14399 }, { "id": 2, "name": "Visa", "requiresDocument": false, "implementation": "Vtex.PaymentGateway.CreditCard.Visa", "connectorImplementation": "Vtex.PaymentGateway.Connectors.PaymentProvider.PaymentProviderConnector_cosmetics2-payment-provider-v0", "antifraudConnectorImplementation": null, "groupName": "creditCard", "redirect": false, "isCustom": false, "isSelfAuthorized": false, "requiresAuthentication": false, "allowInstallments": true, "allowBinExclusion": false, "allowMultiple": true, "allowIssuer": true, "allowCountry": false, "allowCommercialPolicy": true, "allowCommercialCondition": true, "allowPeriod": true, "isAvailable": true, "description": null, "supportRecurrence": true, "validator": { "regex": "^4[0-9]{15}$", "mask": "9999 9999 9999 9999", "cardCodeMask": "999", "cardCodeRegex": "^[0-9]{3}$", "weights": [ 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2 ], "useCvv": true, "useExpirationDate": true, "useCardHolderName": true, "useBillingAddress": true, "validCardLengths": null }, "appDependencies": null, "displayDocument": false, "dueDate": "2023-12-20T11:46:27.2993428Z", "allowNotification": false, "affiliationId": null, "availablePayments": null, "dueDateMinutes": 10079 } ] } } } }, "deprecated": false } }, "/api/payments/pvt/account/{cardId}": { "servers": [ { "url": "https://{accountName}.vtexpayments.com.br", "description": "VTEX server URL.", "variables": { "accountName": { "description": "Name of the VTEX account. Used as part of the URL.", "default": "apiexamples" } } } ], "get": { "tags": [ "Configuration" ], "summary": "Get card data", "description": "Retrieves the public data of a specific credit card stored in the store.\r\n\r\nBefore consulting the card details, consider the following information:\r\n- Sensitive data such as full card number and CVV are not returned.\r\n- The `tokens` field is optional. It is included in the response only if the card you are retrieving has already been tokenized.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/authentication-overview#api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise, they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| PCI Gateway | Payment-ViewPaymentData | **View Payment Data** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "operationId": "GetCardTokenById", "parameters": [ { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" }, { "name": "cardId", "in": "path", "description": "Card identification. This is the `accountId` associated with the client's profile, which can be viewed by accessing [Profile System](https://developers.vtex.com/docs/guides/profile-system#profile-system-api-reference). As a client can have more than one card registered in their profile, check the desired `accountId` and send it in this request.", "required": true, "schema": { "type": "string", "example":"719f3698-d8cb-41af-13a7-41f63982bcd2" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "bin": { "type": "string", "description": "First six digits of the card number." }, "lastDigits": { "type": "string", "description": "Last four digits of the card." }, "expiryMonth": { "type": "string", "description": "Card expiration month (2-digits)." }, "expiryYear": { "type": "string", "description": "Card expiration year (4-digits)." }, "mask": { "type": "string", "description": "Masked card number." }, "paymentSystem": { "type": "integer", "description": "Payment system ID in the Payment Gateway." }, "paymentSystemName": { "type": "string", "description": "Payment system name (card brand)." }, "address": { "type": "object", "description": "Card address (optional).", "properties": { "addressType": { "type": "string", "description": "Address type.", "enum": [ "Residential", "Commercial" ] }, "addressId": { "type": "string", "description": "Address ID." }, "postalCode": { "type": "string", "description": "Postal code." }, "street": { "type": "string", "description": "Street name." }, "neighborhood": { "type": "string", "description": "Neighborhood name." }, "city": { "type": "string", "description": "City name." }, "state": { "type": "string", "description": "State or province." }, "country": { "type": "string", "description": "Country code." }, "number": { "type": "string", "description": "Street number." }, "complement": { "type": "string", "description": "Address complement." } } }, "document": { "type": "string", "description": "Card holder's document." }, "tokens": { "type": "object", "description": "Card tokens information (optional).", "properties": { "providerId": { "type": "string", "description": "Name of the connector's owner account (`accountName`) used to create the token." }, "type": { "type": "string", "description": "Token type stored in the vault.", "enum": [ "FILE", "TOKEN_CLIENT_ID", "TOKEN_VALUE" ] }, "value": { "type": "string", "description": "Token value." }, "expiration": { "type": "string", "description": "Token expiration date in `YYYY-MM` format." }, "label": { "type": "string", "description": "Token alias (an alternative name to simplify token identification)." }, "href": { "type": "string", "description": "URL of the token file stored by the provider." }, "providerCardTokenId": { "type": "string", "description": "Client ID used to retrieve the token from the provider." }, "useCvvForAuthorization": { "type": "boolean", "description": "Flag indicating if CVV is required (`true`) or not (`false`)." }, "extraData": { "type": "object", "description": "Additional metadata stored with the token.", "properties": { "customField1": { "type": "string", "description": "Custom field information." } } } } } } }, "example": { "bin": "370176", "lastDigits": "3550", "expiryMonth": "12", "expiryYear": "2025", "mask": "XXXX-XXXX-XXXX-1111", "paymentSystem": 2, "paymentSystemName": "Visa", "address": { "addressType": "Residential", "addressId": "address-id", "postalCode": "00000-000", "street": "Av. Example", "neighborhood": "Centro", "city": "Example City", "state": "SP", "country": "BRA", "number": "1000", "complement": "Apt 1" }, "document": "12345678900", "tokens": { "providerId": "cosmetics2", "type": "TOKEN_VALUE", "value": "token-value", "expiration": "2025-12", "label": "Primary card", "href": "https://provider.example/token-file", "providerCardTokenId": "provider-token-id", "useCvvForAuthorization": false, "extraData": { "customField1": "value1", "customField2": "value2" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "description": "Error information.", "properties": { "code": { "type": "string", "description": "Error code." }, "message": { "type": "string", "description": "Error message." } } } } }, "example": { "error": { "code": "MissingRequestData", "message": "Could not find account {accountId}" } } } } }, "500": { "description": "Internal Server Error - Payment system not found for the card.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "description": "Error information.", "properties": { "code": { "type": "string", "description": "Error code." }, "message": { "type": "string", "description": "Error message." } } } } }, "example": { "error": { "code": "DatabaseInconsistency", "message": "Card without payment details {accountId}" } } } } } } } }, "/api/pvt/transactions": { "servers": [ { "url": "https://{accountName}.vtexpayments.com.br", "description": "VTEX server URL.", "variables": { "accountName": { "description": "Name of the VTEX account. Used as part of the URL.", "default": "apiexamples" } } } ], "post": { "tags": [ "Transaction Process" ], "summary": "Start a new transaction", "description": "This request is the first step to create a new transaction.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| PCI Gateway | Payment-Make Payments | **Process payments** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>\u2757 To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "operationId": "1.Createanewtransaction", "parameters": [ { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" } ], "security": [ { "appKey": [], "appToken": [] }, { "VtexIdclientAutCookie": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/1.CreateanewtransactionRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StartTransactionResponse" }, "example": { "id": "46351F157C624CBA926359ADED377265", "transactionId": "46351F157C624CBA926359ADED377265", "referenceKey": "1234567", "interactions": { "href": "/api/pvt/transactions/46351F157C624CBA926359ADED377265/interactions" }, "settlements": { "href": "/api/pvt/transactions/46351F157C624CBA926359ADED377265/settlements" }, "payments": { "href": "/api/pvt/transactions/46351F157C624CBA926359ADED377265/payments" }, "refunds": { "href": "/api/pvt/transactions/46351F157C624CBA926359ADED377265/refunds" }, "cancellations": { "href": "/api/pvt/transactions/46351F157C624CBA926359ADED377265/cancellations" }, "capabilities": { "href": "/api/pvt/transactions/46351F157C624CBA926359ADED377265/capabilities" }, "timeoutStatus": 0, "totalRefunds": 0.0, "status": "Started", "value": 20000, "receiverUri": "https://cosmetics2.vtexpayments.com.br/split/46351F157C624CBA926359ADED377265/payments", "startDate": "2023-12-15T19:53:59.4307279Z", "authorizationToken": null, "authorizationDate": null, "commitmentToken": null, "commitmentDate": null, "refundingToken": null, "refundingDate": null, "cancelationToken": null, "cancelationDate": null, "fields": [ { "name": "owner", "value": "teste_1@test.com" }, { "name": "lastTransitionDate", "value": "12/15/2023 7:53:59 PM" }, { "name": "TotalTimeSpentInTransitionsUntilThisTransition", "value": "0" }, { "name": "channel", "value": "cosmetics2" }, { "name": "salesChannel", "value": "1" } ], "ipAddress": null, "sessionId": null, "macId": null, "vtexFingerprint": null, "chargeback": null, "whiteSignature": null, "owner": "teste_1@test.com", "orderId": null, "userAgent": null, "acceptHeader": null, "antifraudTid": null, "antifraudResponse": null, "antifraudReference": null, "antifraudAffiliationId": null, "channel": "cosmetics2", "salesChannel": "1", "urn": null, "softDescriptor": null, "markedForRecurrence": false, "buyer": null } } } } }, "deprecated": false } }, "/api/payments/transactions/{transactionId}/payments": { "servers": [ { "url": "https://api.vtexvault.com", "description": "VTEX Vault server URL." } ], "post": { "tags": [ "Transaction Process" ], "summary": "Send payments information", "description": "This request is used to send the payment data.\r\n\r\n## Permissions\r\n\r\nThis endpoint does not require [authentication](https://developers.vtex.com/docs/guides/authentication) or [permissions](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).", "operationId": "2.SendPaymentsPublic", "parameters": [ { "name": "an", "in": "query", "description": "Account name.", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "cosmetics2" } }, { "name": "orderId", "in": "query", "description": "Order identification.", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "1248716513905" } }, { "$ref": "#/components/parameters/transactionId" }, { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" } ], "security": [], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/2.SendPaymentsPublicRequest" }, "description": "Payment information." } } } }, "responses": { "201": { "description": "Created. This endpoint does not return any data in the response body." } }, "deprecated": false } }, "/api/pvt/transactions/{transactionId}/additional-data": { "servers": [ { "url": "https://{accountName}.vtexpayments.com.br", "description": "VTEX server URL.", "variables": { "accountName": { "description": "Name of the VTEX account. Used as part of the URL.", "default": "apiexamples" } } } ], "post": { "tags": [ "Transaction Process" ], "summary": "Send additional data", "description": "This request sends additional data related to the transaction, such as profile information, shopping cart, shipping data, among others.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| PCI Gateway | Payment-Make Payments | **Process payments** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>\u2757 To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "operationId": "3.SendAdditionalData", "parameters": [ { "$ref": "#/components/parameters/transactionId" }, { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" } ], "security": [ { "appKey": [], "appToken": [] }, { "VtexIdclientAutCookie": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "description": "Array containing additional data.", "items": { "type": "object", "description": "Additional data fields.", "required": [ "name", "value" ], "properties": { "name": { "type": "string", "description": "Dataset name. This information must be sent in escaped JSON format." }, "value": { "type": "string", "description": "Dataset values. This information must be sent in escaped JSON format." } } } }, "example": [ { "name": "cart", "value": "{\"items\":[{\"id\":\"6257034\",\"name\":\"Tamanco Couro Preto Poá\",\"value\":5999,\"quantity\":1,\"priceTags\":[],\"components\":null,\"commission\":0.0,\"freightCommission\":0.0,\"sellerChain\":null,\"shippingDiscount\":0,\"discount\":0,\"refId\":\"C503YC002_34\",\"productId\":\"6257000\",\"sellingPrice\":59.99,\"sellerId\":\"1\",\"dockId\":\"999800000-5\",\"categoryId\":\"18\",\"categoryName\":\"Tamanco\",\"deliveryChannel\":\"delivery\",\"deliveryType\":\"Convencional\",\"deliverySlaInMinutes\":5760,\"deliveryWindow\":null,\"tax\":0,\"freight\":167},{\"id\":\"7136034\",\"name\":\"Sandália Off White Espadrile Salto Forrado\",\"value\":5999,\"quantity\":1,\"priceTags\":[],\"components\":null,\"commission\":0.0,\"freightCommission\":0.0,\"sellerChain\":null,\"shippingDiscount\":0,\"discount\":0,\"refId\":\"S5146R881_34\",\"productId\":\"7136000\",\"sellingPrice\":59.99,\"sellerId\":\"1\",\"dockId\":\"999800000-5\",\"categoryId\":\"12\",\"categoryName\":\"Anabela\",\"deliveryChannel\":\"delivery\",\"deliveryType\":\"Convencional\",\"deliverySlaInMinutes\":5760,\"deliveryWindow\":null,\"tax\":0,\"freight\":166},{\"id\":\"8305038\",\"name\":\"Tamanco Caramelo Salto Fachete\",\"value\":9999,\"quantity\":1,\"priceTags\":[],\"components\":null,\"commission\":0.0,\"freightCommission\":0.0,\"sellerChain\":null,\"shippingDiscount\":0,\"discount\":0,\"refId\":\"S534IZ012_38\",\"productId\":\"8305000\",\"sellingPrice\":99.99,\"sellerId\":\"1\",\"dockId\":\"999800000-5\",\"categoryId\":\"18\",\"categoryName\":\"Tamanco\",\"deliveryChannel\":\"delivery\",\"deliveryType\":\"Convencional\",\"deliverySlaInMinutes\":5760,\"deliveryWindow\":null,\"tax\":0,\"freight\":166},{\"id\":\"7641034\",\"name\":\"Tênis Slip On Couro Preto Recorte\",\"value\":9999,\"quantity\":1,\"priceTags\":[],\"components\":null,\"commission\":0.0,\"freightCommission\":0.0,\"sellerChain\":null,\"shippingDiscount\":0,\"discount\":0,\"refId\":\"C524B9002_34\",\"productId\":\"7641000\",\"sellingPrice\":99.99,\"sellerId\":\"coinshop\",\"dockId\":\"0405\",\"categoryId\":\"30\",\"categoryName\":\"Clássico\",\"deliveryChannel\":\"delivery\",\"deliveryType\":\"Correios - PAC\",\"deliverySlaInMinutes\":18720,\"deliveryWindow\":null,\"tax\":0,\"freight\":7138},{\"id\":\"8278038\",\"name\":\"Tênis Slip Caramelo Matelassê\",\"value\":5999,\"quantity\":1,\"priceTags\":[],\"components\":null,\"commission\":0.0,\"freightCommission\":0.0,\"sellerChain\":null,\"shippingDiscount\":0,\"discount\":0,\"refId\":\"S534IR012_38\",\"productId\":\"8278000\",\"sellingPrice\":59.99,\"sellerId\":\"coinmarket\",\"dockId\":\"0571\",\"categoryId\":\"32\",\"categoryName\":\"Slip On\",\"deliveryChannel\":\"delivery\",\"deliveryType\":\"PAC\",\"deliverySlaInMinutes\":14400,\"deliveryWindow\":null,\"tax\":0,\"freight\":7090}],\"sellers\":[{\"id\":\"1\",\"name\":\"CONSTANCE\",\"documentType\":\"CNPJ\",\"document\":\"30901791000191\"},{\"id\":\"coinshop\",\"name\":\"coinshop\",\"documentType\":\"CNPJ\",\"document\":\"48275547000126\"},{\"id\":\"coinmarket\",\"name\":\"coinmarket\",\"documentType\":\"CNPJ\",\"document\":\"48314133000169\"}],\"freight\":14727,\"shippingdate\":null,\"shippingestimated\":\"4bd\",\"orderUrl\":\"http://www.constance.com.br/admin/checkout/#/orders?q=1373160984904\",\"tax\":0,\"isGiftRegistry\":null,\"giftRegistryDescription\":null,\"giftRegistryId\":null,\"isPickupStore\":null,\"isCallCenter\":null}" }, { "name": "clientProfileData", "value": "{\"email\":\"test@test.com\",\"firstName\":\"Izidio\",\"lastName\":\"Test Trace\",\"document\":\"111111111\",\"phone\":\"+56987654321\",\"corporateName\":null,\"tradeName\":null,\"corporateDocument\":null,\"stateInscription\":\"Exento\",\"postalCode\":\"8320000\",\"address\":{\"receiverName\":\"wqqw weqw\",\"postalCode\":\"8320000\",\"city\":\"wdade\",\"state\":\"Región Metropolitana\",\"country\":\"CHL\",\"street\":\"asdafd\",\"number\":\"sadas\",\"neighborhood\":\"Santiago\",\"complement\":\"604\",\"reference\":\"efa\"},\"gender\":null,\"birthDate\":null,\"createdDate\":null,\"corporatePhone\":null,\"isCorporate\":false,\"documentType\":\"rutCHL\",\"id\":\"d48a1cd3-c04e-4949-a275-df4b197a7ec9\"}" } ] } } }, "responses": { "200": { "description": "OK. This endpoint does not return any data in the response body." } }, "deprecated": false }, "patch": { "tags": [ "Transaction Process" ], "summary": "Update additional data (optional)", "description": "This request is used to update any information that has previously been sent on endpoint [Send additional data](https://developers.vtex.com/docs/api-reference/payments-gateway-api#post-/api/pvt/transactions/-transactionId-/additional-data).\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| PCI Gateway | Payment-Make Payments | **Process payments** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>\u2757 To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "operationId": "3.1UpdateAdditionalData", "parameters": [ { "$ref": "#/components/parameters/transactionId" }, { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" } ], "security": [ { "appKey": [], "appToken": [] }, { "VtexIdclientAutCookie": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "description": "Array containing additional data.", "items": { "type": "object", "description": "Additional data fields.", "required": [ "name", "value" ], "properties": { "name": { "type": "string", "description": "Dataset name. This information must be sent in escaped JSON format." }, "value": { "type": "string", "description": "Dataset values. This information must be sent in escaped JSON format." } } } }, "example": [ { "name": "cart", "value": "{\"items\":[{\"id\":\"6257034\",\"name\":\"Tamanco Couro Preto Poá\",\"value\":5999,\"quantity\":1,\"priceTags\":[],\"components\":null,\"commission\":0.0,\"freightCommission\":0.0,\"sellerChain\":null,\"shippingDiscount\":0,\"discount\":0,\"refId\":\"C503YC002_34\",\"productId\":\"6257000\",\"sellingPrice\":59.99,\"sellerId\":\"1\",\"dockId\":\"999800000-5\",\"categoryId\":\"18\",\"categoryName\":\"Tamanco\",\"deliveryChannel\":\"delivery\",\"deliveryType\":\"Convencional\",\"deliverySlaInMinutes\":5760,\"deliveryWindow\":null,\"tax\":0,\"freight\":167},{\"id\":\"7136034\",\"name\":\"Sandália Off White Espadrile Salto Forrado\",\"value\":5999,\"quantity\":1,\"priceTags\":[],\"components\":null,\"commission\":0.0,\"freightCommission\":0.0,\"sellerChain\":null,\"shippingDiscount\":0,\"discount\":0,\"refId\":\"S5146R881_34\",\"productId\":\"7136000\",\"sellingPrice\":59.99,\"sellerId\":\"1\",\"dockId\":\"999800000-5\",\"categoryId\":\"12\",\"categoryName\":\"Anabela\",\"deliveryChannel\":\"delivery\",\"deliveryType\":\"Convencional\",\"deliverySlaInMinutes\":5760,\"deliveryWindow\":null,\"tax\":0,\"freight\":166},{\"id\":\"8305038\",\"name\":\"Tamanco Caramelo Salto Fachete\",\"value\":9999,\"quantity\":1,\"priceTags\":[],\"components\":null,\"commission\":0.0,\"freightCommission\":0.0,\"sellerChain\":null,\"shippingDiscount\":0,\"discount\":0,\"refId\":\"S534IZ012_38\",\"productId\":\"8305000\",\"sellingPrice\":99.99,\"sellerId\":\"1\",\"dockId\":\"999800000-5\",\"categoryId\":\"18\",\"categoryName\":\"Tamanco\",\"deliveryChannel\":\"delivery\",\"deliveryType\":\"Convencional\",\"deliverySlaInMinutes\":5760,\"deliveryWindow\":null,\"tax\":0,\"freight\":166},{\"id\":\"7641034\",\"name\":\"Tênis Slip On Couro Preto Recorte\",\"value\":9999,\"quantity\":1,\"priceTags\":[],\"components\":null,\"commission\":0.0,\"freightCommission\":0.0,\"sellerChain\":null,\"shippingDiscount\":0,\"discount\":0,\"refId\":\"C524B9002_34\",\"productId\":\"7641000\",\"sellingPrice\":99.99,\"sellerId\":\"coinshop\",\"dockId\":\"0405\",\"categoryId\":\"30\",\"categoryName\":\"Clássico\",\"deliveryChannel\":\"delivery\",\"deliveryType\":\"Correios - PAC\",\"deliverySlaInMinutes\":18720,\"deliveryWindow\":null,\"tax\":0,\"freight\":7138},{\"id\":\"8278038\",\"name\":\"Tênis Slip Caramelo Matelassê\",\"value\":5999,\"quantity\":1,\"priceTags\":[],\"components\":null,\"commission\":0.0,\"freightCommission\":0.0,\"sellerChain\":null,\"shippingDiscount\":0,\"discount\":0,\"refId\":\"S534IR012_38\",\"productId\":\"8278000\",\"sellingPrice\":59.99,\"sellerId\":\"coinmarket\",\"dockId\":\"0571\",\"categoryId\":\"32\",\"categoryName\":\"Slip On\",\"deliveryChannel\":\"delivery\",\"deliveryType\":\"PAC\",\"deliverySlaInMinutes\":14400,\"deliveryWindow\":null,\"tax\":0,\"freight\":7090}],\"sellers\":[{\"id\":\"1\",\"name\":\"CONSTANCE\",\"documentType\":\"CNPJ\",\"document\":\"30901791000191\"},{\"id\":\"coinshop\",\"name\":\"coinshop\",\"documentType\":\"CNPJ\",\"document\":\"48275547000126\"},{\"id\":\"coinmarket\",\"name\":\"coinmarket\",\"documentType\":\"CNPJ\",\"document\":\"48314133000169\"}],\"freight\":14727,\"shippingdate\":null,\"shippingestimated\":\"4bd\",\"orderUrl\":\"http://www.constance.com.br/admin/checkout/#/orders?q=1373160984904\",\"tax\":0,\"isGiftRegistry\":null,\"giftRegistryDescription\":null,\"giftRegistryId\":null,\"isPickupStore\":null,\"isCallCenter\":null}" }, { "name": "clientProfileData", "value": "{\"email\":\"test@test.com\",\"firstName\":\"Izidio\",\"lastName\":\"Test Trace\",\"document\":\"111111111\",\"phone\":\"+56987654321\",\"corporateName\":null,\"tradeName\":null,\"corporateDocument\":null,\"stateInscription\":\"Exento\",\"postalCode\":\"8320000\",\"address\":{\"receiverName\":\"wqqw weqw\",\"postalCode\":\"8320000\",\"city\":\"wdade\",\"state\":\"Región Metropolitana\",\"country\":\"CHL\",\"street\":\"asdafd\",\"number\":\"sadas\",\"neighborhood\":\"Santiago\",\"complement\":\"604\",\"reference\":\"efa\"},\"gender\":null,\"birthDate\":null,\"createdDate\":null,\"corporatePhone\":null,\"isCorporate\":false,\"documentType\":\"rutCHL\",\"id\":\"d48a1cd3-c04e-4949-a275-df4b197a7ec9\"}" } ] } } }, "responses": { "200": { "description": "OK. This endpoint does not return any data in the response body." } }, "deprecated": false } }, "/api/pvt/transactions/{transactionId}/authorization-request": { "servers": [ { "url": "https://{accountName}.vtexpayments.com.br", "description": "VTEX server URL.", "variables": { "accountName": { "description": "Name of the VTEX account. Used as part of the URL.", "default": "apiexamples" } } } ], "post": { "tags": [ "Transaction Process" ], "summary": "Authorize new transaction", "description": "This request authorizes the creation of a new transaction according to the data previously informed in the last requests.\r\n\r\nThis step is the trigger to process each of payments that were received in step 2.\r\n\r\nEach payment will be sent to acquirer. If all payments are authorized, the transaction will be authorized. If one of the payments is denied, all payments in transaction will be cancelled.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| PCI Gateway | Payment-Make Payments | **Process payments** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>\u2757 To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "operationId": "4.Doauthorization", "parameters": [ { "$ref": "#/components/parameters/transactionId" }, { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" } ], "security": [ { "appKey": [], "appToken": [] }, { "VtexIdclientAutCookie": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/4.DoauthorizationRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettleResponse" }, "example": { "id": null, "token": "2BCA48B4FBCB42D0B8A19EE965712AD8", "status": 8, "statusDetail": "Approved", "processingDate": "2023-12-14T22:45:50.9977213Z", "refundedValue": 0, "refundedToken": null, "message": null, "code": null, "connectorRefundedValue": 0, "cancelledValue": 0 } } } } }, "deprecated": false } }, "/api/pvt/transactions/{transactionId}": { "servers": [ { "url": "https://{accountName}.vtexpayments.com.br", "description": "VTEX server URL.", "variables": { "accountName": { "description": "Name of the VTEX account. Used as part of the URL.", "default": "apiexamples" } } } ], "get": { "tags": [ "Transaction Process" ], "summary": "Get transaction details", "description": "Returns data about a specific transaction made in your store.\r\n\r\n>⚠️ Do not use the `interactions.href` route which is part of this endpoint's response. This is an internal-only route not meant to be used by external developers.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| PCI Gateway | Payment-Make Payments | **View Payment Data** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>\u2757 To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "operationId": "TransactionDetails", "parameters": [ { "$ref": "#/components/parameters/transactionId" }, { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" } ], "security": [ { "appKey": [], "appToken": [] }, { "VtexIdclientAutCookie": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionDetailsResponse" }, "example": { "id": "D3640578F8124C50CB42BD3F8D282CD9", "transactionId": "D3640578F8124C50CB42BD3F8D282CD9", "referenceKey": "505288", "interactions": { "href": "/api/pvt/transactions/D3640578F8124C50CB42BD3F8D282CD9/interactions" }, "settlements": { "href": "/api/pvt/transactions/D3640578F8124C50CB42BD3F8D282CD9/settlements" }, "payments": { "href": "/api/pvt/transactions/D3640578F8124C50CB42BD3F8D282CD9/payments" }, "refunds": { "href": "/api/pvt/transactions/D3640578F8124C50CB42BD3F8D282CD9/refunds" }, "cancellations": { "href": "/api/pvt/transactions/D3640578F8124C50CB42BD3F8D282CD9/cancellations" }, "capabilities": { "href": "/api/pvt/transactions/D3640578F8124C50CB42BD3F8D282CD9/capabilities" }, "timeoutStatus": 0, "totalRefunds": 0.0, "status": "Finished", "value": 61400, "receiverUri": null, "startDate": "2023-06-02T17:04:19", "authorizationToken": "0C825428F9804701A8DCF2BE9E0968C4", "authorizationDate": "2023-06-02T17:04:24", "commitmentToken": "1E25BAB9A8F84DBC8A5E4AC26A0A534H", "commitmentDate": "2023-06-02T17:05:44", "refundingToken": null, "refundingDate": null, "cancelationToken": null, "cancelationDate": null, "fields": [ { "name": "owner", "value": "vtexappkey-appvtex" }, { "name": "conditions", "value": "[{\"id\":\"1\",\"value\":609.0}]" }, { "name": "postbackStatusUrl", "value": "https://oms.vtexcommercestable.com.br/api/oms/pvt/orders/order-group/1336650505288/notifications/transaction-status?an=cosmetics2" }, { "name": "shopperInteraction", "value": "ecommerce" }, { "name": "lastTransitionDate", "value": "6/2/2023 5:05:44 PM" }, { "name": "TotalTimeSpentInTransitionsUntilThisTransition", "value": "87581.1868" }, { "name": "channel", "value": "COSMETICS2" }, { "name": "salesChannel", "value": "1" }, { "name": "parentMerchant", "value": "a8b27fb4-6516-4cc0-82b6-a5f2b011e6e2" }, { "name": "orderId", "value": "1336650505288" }, { "name": "ip", "value": "152.248.55.27" }, { "name": "sessionId", "value": "09d7f6d1-53fe-4e6f-95de-2a0c38c8c0d0" }, { "name": "macId", "value": "89314737-9d03-4607-9814-61ed1a59b0bd" }, { "name": "userAgent", "value": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/113.0.0.0 Safari/537.36" }, { "name": "acceptHeader", "value": "application/json,text/plain,*/*" }, { "name": "deviceInfo", "value": "{\"screenWidth\":1920,\"screenHeight\":1080,\"colorDepth\":24,\"timeZoneOffset\":180,\"language\":\"en\",\"javaEnabled\":false,\"acceptHeader\":\"application/json,text/plain,*/*\",\"userAgent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/113.0.0.0 Safari/537.36\",\"ipAddress\":\"152.248.55.27\",\"sourceApplication\":\"vcs.checkout-ui@v6.83.1\",\"installedApplications\":[\"payment-provider\",\"adyen-authentication-app\",\"cielo-authentication-app\",\"pix-payment\",\"google-pay-payment-authorization-app\",\"apple-pay-payment-authorization-app\"]}" }, { "name": "cart", "value": "{\"items\":[{\"id\":\"9\",\"name\":\"Matcha Butter Conditioning Mask 100 ml\",\"value\":60900,\"quantity\":1,\"priceTags\":[],\"components\":null,\"commission\":0.0,\"freightCommission\":0.0,\"sellerChain\":null,\"shippingDiscount\":0,\"discount\":0,\"refId\":null,\"productId\":\"4\",\"sellingPrice\":609.0,\"sellerId\":\"vtxfqw4064\",\"dockId\":\"doca_principal\",\"categoryId\":\"1\",\"categoryName\":\"Treatments\",\"deliveryChannel\":\"delivery\",\"deliveryType\":\"Normal\",\"deliverySlaInMinutes\":4320,\"deliveryWindow\":null,\"tax\":0,\"freight\":500}],\"sellers\":[{\"id\":\"vtxfqw4064\",\"name\":\"「ホワイトレーベル」ヴィトルのショップ\",\"documentType\":\"CNPJ\",\"document\":null}],\"freight\":500,\"shippingdate\":null,\"shippingestimated\":\"3bd\",\"orderUrl\":\"http://vtexdayhackaton--cosmetics2.myvtex.com/admin/checkout/#/orders?q=1336650505288\",\"tax\":0,\"isGiftRegistry\":null,\"giftRegistryDescription\":null,\"giftRegistryId\":null,\"isPickupStore\":null,\"isCallCenter\":null}" }, { "name": "clientProfileData", "value": "{\"email\":\"teste@teste.com\",\"firstName\":\"teste\",\"lastName\":\"teste\",\"document\":\"01234567890\",\"phone\":\"+5511999999999\",\"corporateName\":null,\"tradeName\":null,\"corporateDocument\":null,\"stateInscription\":null,\"postalCode\":\"22250-040\",\"address\":{\"receiverName\":\"test\",\"postalCode\":\"22250040\",\"city\":\"Rio de Janeiro\",\"state\":\"RJ\",\"country\":\"BRA\",\"street\":\"Praia Botafogo\",\"number\":\"123\",\"neighborhood\":\"Botafogo\",\"complement\":null,\"reference\":null},\"gender\":null,\"birthDate\":null,\"createdDate\":\"2023-06-01T03:09:50.408969Z\",\"corporatePhone\":null,\"isCorporate\":false,\"documentType\":\"cpf\",\"id\":\"db324ab8-fd91-40b3-b31f-c63b3b602495\"}" }, { "name": "shippingData", "value": "{\"receiverName\":\"test\",\"postalCode\":\"22250040\",\"city\":\"Rio de Janeiro\",\"state\":\"RJ\",\"country\":\"BRA\",\"street\":\"Praia Botafogo\",\"number\":\"123\",\"neighborhood\":\"Botafogo\",\"complement\":null,\"reference\":null}" }, { "name": "retainPartialSettlements", "value": "False" } ], "shopperInteraction": "ecommerce", "ipAddress": "152.248.55.27", "sessionId": "09d7f6d1-53fe-4e6f-95de-2a0c38c8c0d0", "macId": "89314737-9d03-4607-9814-61ed1a59b0bd", "vtexFingerprint": null, "chargeback": null, "whiteSignature": null, "owner": "vtexappkey-appvtex", "orderId": "1336650505288", "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/17.0 Safari/605.1.15", "acceptHeader": "application/json,text/plain,*/*", "antifraudTid": null, "antifraudResponse": null, "antifraudReference": null, "antifraudAffiliationId": null, "channel": "COSMETICS2", "salesChannel": "1", "urn": null, "softDescriptor": "company_name_description_code", "markedForRecurrence": false, "buyer": { "firstName": "HUXXXXX", "lastName": "PERXXXX", "documentType": "cpf", "document": "169XXXXX718", "email": "test@test.com", "address": "BRA 2163XXXXXXXXzile 58", "phone": "219XXXX695" } } } } } }, "deprecated": false } }, "/api/pvt/transactions/{transactionId}/payments/{paymentId}": { "servers": [ { "url": "https://{accountName}.vtexpayments.com.br", "description": "VTEX server URL.", "variables": { "accountName": { "description": "Name of the VTEX account. Used as part of the URL.", "default": "apiexamples" } } } ], "get": { "tags": [ "Transaction Process" ], "summary": "Get payment details", "description": "Returns data about a specific payment made in your store.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| PCI Gateway | Payment-Make Payments | **View Payment Data** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>\u2757 To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "operationId": "PaymentDetails", "parameters": [ { "$ref": "#/components/parameters/transactionId" }, { "name": "paymentId", "in": "path", "description": "Payment identification.", "required": true, "style": "simple", "schema": { "type": "string", "example": "B2E754DCD7304D22866CB6F221CF0FEB" } }, { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" } ], "security": [ { "appKey": [], "appToken": [] }, { "VtexIdclientAutCookie": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentDetailsResponse" }, "example": { "id": "20147A81H48B64D8DA1423AFD32D6671C", "paymentSystem": 2, "paymentSystemName": "Visa", "merchantName": null, "group": "creditCard", "userProfileId": null, "isCustom": false, "allowInstallments": true, "requiresAuthentication": false, "allowIssuer": true, "allowNotification": false, "isAvailable": true, "description": null, "authorizationDate": "2023-06-02T17:04:23", "self": { "href": "/api/pvt/transactions/D8640778F8194C50BB42BD4F9D282AD8/payments/20147A81H48B64D8DA1423AFD32D6671C" }, "tid": "pi_3NEbOkCp13eGpuNm179AVYJ5", "nsu": null, "returnCode": null, "returnMessage": null, "status": "Finished", "connector": "payment-test-v1", "ConnectorResponses": { "Tid": "pi_3NEbOkCp13eGpuNm172AVYJ4", "ReturnCode": null, "Message": null, "authId": "kh07vt", "nsu": "p0dug1" }, "connectorResponse": { "Tid": "pi_3NEbOkCp13eGpuNm172AVYJ4", "ReturnCode": null, "Message": null, "authId": "kh07vt", "nsu": "p0dug1" }, "ShowConnectorResponses": true, "value": 61400, "installmentsInterestRate": 0, "installmentsValue": 61400, "referenceValue": 61400, "installments": 1, "currencyCode": "BRL", "provider": null, "isBillingAddressDifferent": false, "isRegexValid": null, "isLuhnValid": null, "fields": [ { "name": "AvailableRules", "value": "74410430-43b4-4b40-99f4-887f18f945dd,dc47c1f5-6950-4e38-b3af-1f56fc56ddd9,52e7e8ff-8508-4ac4-a78a-c5ddb054a0ee" }, { "name": "originalPaymentSystem", "value": "2" }, { "name": "callbackUrl", "value": "https://payment-test.myvtex.com/checkout/gatewayCallback/1336650505288/Success" }, { "name": "baseUrl", "value": "https://payment-test.vtexpayments.com.br:443" }, { "name": "currencyCode", "value": "BRL" }, { "name": "usedAccountId", "value": "True" }, { "name": "cardHolder", "value": "teste teste" }, { "name": "firstDigits", "value": "400000" }, { "name": "lastDigits", "value": "0002" }, { "name": "expiryMonth", "value": "05" }, { "name": "expiryYear", "value": "2038" }, { "name": "parentAccountId", "value": "08134AF761A148B9A5DCE14A81F31DD9" }, { "name": "accountId", "value": "08134AF761A148B9A5DCE14A81F31DD9" }, { "name": "address", "value": "{\"addressType\":\"residential\",\"addressId\":\"8427936352555\",\"postalCode\":\"22250040\",\"street\":\"Praia Botafogo\",\"neighborhood\":\"Botafogo\",\"city\":\"Rio de Janeiro\",\"state\":\"RJ\",\"country\":\"BRA\",\"number\":\"123\",\"complement\":null}" }, { "name": "affiliationId", "value": "4696dd94-a6c2-4206-a90e-6348d7fb8a97" }, { "name": "ruleId", "value": "74450431-23b4-4b40-99f4-887f18f945dd" }, { "name": "ruleName", "value": "payment test" }, { "name": "sequence", "value": "505288-0" }, { "name": "paymentMethod", "value": "Visa" }, { "name": "authorizationConnectorResponse", "value": "{\"paymentId\":\"20147A81H48B64D8DA1423AFD32D6671C\",\"status\":\"approved\",\"acquirer\":null,\"code\":null,\"message\":null,\"authorizationId\":\"kh07vt\",\"nsu\":\"p0dug1\",\"tid\":\"i_3NEbOkCp13eGpuNm172AVYJ4\"}" }, { "name": "tid", "value": "pi_3NEbOkCp13eGpuNm172AVYJ4" }, { "name": "connector", "value": "Vtex.PaymentGateway.Connectors.PaymentProvider.PaymentProviderConnector" }, { "name": "waitingForAutoSettle", "value": "06/06/2023 17:04:23 P UTC" }, { "name": "settlementConnectorResponse", "value": "{\"settleId\":\"iy20l\",\"value\":614.0,\"requestId\":\"2023-06-02T17:05:42-61400\",\"paymentId\":\"20147A81H48B64D8DA1423AFD32D6671C\",\"code\":null,\"message\":null}" }, { "name": "refundingConnectorResponse", "value": "{\"refundId\":null,\"value\":0.0,\"requestId\":\"req_SDh1bz40RayDaI\",\"paymentId\":null,\"code\":\"charge_already_refunded\",\"message\":\"Charge ch_3NEbOkCp13eGpuNm1XGACuQG has already been refunded.\"}" }, { "name": "refund", "value": "[{\"Id\":\"53e9229e-eac7-4fce-b353-55be479e9d6d\",\"Token\":\"05136362B4464EBB99191A188033A048\",\"RefundDate\":\"2023-06-02T17:05:59.4129308Z\",\"ValueAsInt\":100,\"RefundType\":1},{\"Id\":\"b19bf9e5-0c13-495f-9316-41a857251be7\",\"Token\":\"D8640778F8194C50BB42BD4F9D282AD8\",\"RefundDate\":\"2023-06-02T17:06:08.4184954Z\",\"ValueAsInt\":61300,\"RefundType\":0}]" } ], "sheets": null, "originalPaymentId": null } } } } }, "deprecated": false } }, "/api/pvt/transactions/{transactionId}/settlements": { "servers": [ { "url": "https://{accountName}.vtexpayments.com.br", "description": "VTEX server URL.", "variables": { "accountName": { "description": "Name of the VTEX account. Used as part of the URL.", "default": "apiexamples" } } } ], "get": { "tags": [ "Transaction Process" ], "summary": "Get transaction settlement details", "description": "Returns settlement data associated with a specific transaction.\r\n\r\nThe response body of this endpoint may return different information depending on the status of the settlement request for the queried transaction:\r\n\r\n- **Transaction settlement not requested or initiated:** The response body does not return any data.\r\n\r\n- **Settlement request initiated, but not completed as there are items that have not yet been invoiced in the order:** The response body will only display the `request` array information.\r\n\r\n- **Transaction settlement completed:** The response body will display the `request` and `actions` arrays information.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| PCI Gateway | Payment-Make Payments | **View Payment Data** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>\u2757 To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "operationId": "TransactionSettlementDetails", "parameters": [ { "$ref": "#/components/parameters/transactionId" }, { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" } ], "security": [ { "appKey": [], "appToken": [] }, { "VtexIdclientAutCookie": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionSettlementDetails" }, "example": { "requests": [ { "id": "AFB933448FFD4867BF82BCC7026A082C", "date": "2018-06-05T13:08:22", "value": 4499000 } ], "actions": [ { "paymentId": "87055E7199A446519EB07F1243D5B8BE", "payment": { "href": "/api/pvt/transactions/074D48049B19403A930FA848C6BE4AF9/payments/87055E7199A446519EB07F1243D5B8BE" }, "date": "2018-06-05T12:55:58.6262759Z", "type": "auto-settlement", "value": 4499000, "connectorResponse": null } ] } } } } }, "deprecated": false } }, "/api/pvt/transactions/{transactionId}/settlement-request": { "servers": [ { "url": "https://{accountName}.vtexpayments.com.br", "description": "VTEX server URL.", "variables": { "accountName": { "description": "Name of the VTEX account. Used as part of the URL.", "default": "apiexamples" } } } ], "post": { "tags": [ "Transaction Flow" ], "summary": "Settle the transaction", "description": "Settles the transaction amount. A payment settled means that the seller will receive the value of the purchase value after bank conciliation.\r\n\r\n>ℹ️ This call is mandatory to complete a transaction and its payments.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| PCI Gateway | Payment-Make Payments | **Process payments** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>\u2757 To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "operationId": "Settlethetransaction", "parameters": [ { "$ref": "#/components/parameters/transactionId" }, { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" } ], "security": [ { "appKey": [], "appToken": [] }, { "VtexIdclientAutCookie": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettlethetransactionRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettleResponse" }, "example": { "id": null, "token": "2BCA48B4FBCB42D0B8A19EE965712AD8", "status": 11, "statusDetail": "Settling", "processingDate": "2023-12-14T22:45:50.9977213Z", "refundedValue": 0, "refundedToken": null, "message": null, "code": null, "connectorRefundedValue": 0, "cancelledValue": 0 } } } } }, "deprecated": false } }, "/api/pvt/transactions/{transactionId}/refunding-request": { "servers": [ { "url": "https://{accountName}.vtexpayments.com.br", "description": "VTEX server URL.", "variables": { "accountName": { "description": "Name of the VTEX account. Used as part of the URL.", "default": "apiexamples" } } } ], "post": { "tags": [ "Transaction Flow" ], "summary": "Refund the transaction", "description": "Refunds the amount of the transaction that was previously settled.\r\n\r\nAfter a transaction is settled, this request can be used to partially or fully refund the transaction amount.\r\n\r\nDue to acquirer rules, it is not possible to perform this step online against the acquirer, and, if an error occurrs, we notify the seller company responsible by email to manually check the transaction status against the acquirer.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| PCI Gateway | Payment-Make Payments | **Process payments** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>\u2757 To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "operationId": "Refundthetransaction", "parameters": [ { "$ref": "#/components/parameters/transactionId" }, { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" } ], "security": [ { "appKey": [], "appToken": [] }, { "VtexIdclientAutCookie": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefundthetransactionRequest" }, "example": { "value": 2300, "freight": 200, "tax": 0, "minicart": { "items": [ { "id": "122323", "name": "Tenis Preto I", "value": 1000, "quantity": 1, "shippingDiscount": 0, "discount": 50 }, { "id": "122324", "name": "Tenis Nike Azul", "value": 1100, "quantity": 1, "shippingDiscount": 0, "discount": 50 } ] } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettleResponse" }, "example": { "id": null, "token": "2BCA48B4FBCB42D0B8A19EE965712AD8", "status": 11, "statusDetail": "Settling", "processingDate": "2023-12-14T22:45:50.9977213Z", "refundedValue": 2500, "refundedToken": null, "message": null, "code": null, "connectorRefundedValue": 0, "cancelledValue": 0 } } } } }, "deprecated": false } }, "/api/pvt/transactions/{transactionId}/cancellation-request": { "servers": [ { "url": "https://{accountName}.vtexpayments.com.br", "description": "VTEX server URL.", "variables": { "accountName": { "description": "Name of the VTEX account. Used as part of the URL.", "default": "apiexamples" } } } ], "post": { "tags": [ "Transaction Flow" ], "summary": "Cancel the transaction", "description": "Cancels a transaction that was previously approved, but not settled. It is possible to cancel partially or complete value of the transaction.\r\n\r\nDue to acquirer rules it is not possible to perform this step online against the acquirer.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| PCI Gateway | Payment-Make Payments | **Process payments** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>\u2757 To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "operationId": "Cancelthetransaction", "parameters": [ { "$ref": "#/components/parameters/transactionId" }, { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" } ], "security": [ { "appKey": [], "appToken": [] }, { "VtexIdclientAutCookie": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelthetransactionRequest" }, "example": { "value": 2300 } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettleResponse" }, "example": { "id": null, "token": "2BCA48B4FBCB42D0B8A19EE965712AD8", "status": 13, "statusDetail": "Finished", "processingDate": "2023-12-14T22:45:50.9977213Z", "refundedValue": 0, "refundedToken": null, "message": null, "code": null, "connectorRefundedValue": 0, "cancelledValue": 74269 } } } } }, "deprecated": false } }, "/api/payments/pvt/payments/{paymentId}/payment-notification": { "servers": [ { "url": "https://{accountName}.vtexpayments.com.br", "description": "VTEX server URL.", "variables": { "accountName": { "description": "Name of the VTEX account. Used as part of the URL.", "default": "apiexamples" } } } ], "get": { "tags": [ "Payment notification" ], "summary": "Send payment notification with payment ID", "description": "Sends a payment notification for an order based on the payment ID.\r\n\r\n>ℹ If the payment was made on its creation date and for the full amount, use this endpoint. Otherwise, use the alternative endpoint: `POST` [Send payment notification with payment ID, date, and value paid](https://developers.vtex.com/docs/api-reference/payments-gateway-api#post-/api/payments/pvt/payments/-paymentId-/payment-notification).\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/authentication-overview#api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise, they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| PCI Gateway | Payment-NotifyPayments | **Payments Notification** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** |\r\n| --------------- | ----------------- |\r\n| Payments Notifier | **Payments Notification** |\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).", "parameters": [ { "$ref": "#/components/parameters/paymentId" }, { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" } ], "security": [ { "appKey": [], "appToken": [] }, { "VtexIdclientAutCookie": [] } ], "responses": { "200": { "description": "OK" } }, "deprecated": false }, "post": { "tags": [ "Payment notification" ], "summary": "Send payment notification with payment ID, date, and value paid", "description": "Sends a payment notification for an order using the payment ID, including the payment date and the value paid.\r\n\r\n>ℹ️ This endpoint should only be used when the payment was not completed on its creation date or was partially completed (e.g., $50 out of $100). If the payment was made in full on the creation date, use the `GET` [Send payment notification with payment ID](https://developers.vtex.com/docs/api-reference/payments-gateway-api#get-/api/payments/pvt/payments/-paymentId-/payment-notification) endpoint instead. \r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/authentication-overview#api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise, they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| PCI Gateway | Payment-NotifyPayments | **Payments Notification** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** |\r\n| --------------- | ----------------- |\r\n| Payments Notifier | **Payments Notification** |\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).", "parameters": [ { "$ref": "#/components/parameters/paymentId" }, { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" } ], "security": [ { "appKey": [], "appToken": [] }, { "VtexIdclientAutCookie": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotifyPaymentRequest" }, "example": { "paymentDate": "01/01/2025", "valuePaid": 50.1 } } } }, "responses": { "200": { "description": "OK" } }, "deprecated": false } } }, "components": { "schemas": { "ValidRequest": { "required": [ "value", "installments" ], "type": "object", "description": "Installments options response body information.", "properties": { "value": { "type": "number", "description": "Value to be paid in installments." }, "installments": { "type": "array", "items": { "$ref": "#/components/schemas/Installment" }, "description": "Installments information." } } }, "Installment": { "required": [ "payment", "options" ], "type": "object", "description": "Installment options information.", "properties": { "payment": { "$ref": "#/components/schemas/Payment" }, "options": { "type": "array", "description": "Array containing information about installment options.", "items": { "$ref": "#/components/schemas/Option" } } } }, "Payment": { "required": [ "id", "name", "bin", "value", "isDefault", "self" ], "type": "object", "description": "Payment system information.", "properties": { "id": { "type": "integer", "description": "Payment system identification." }, "name": { "type": "string", "description": "Payment system name.", "nullable": true }, "bin": { "type": "string", "description": "First six digits of the card number.", "nullable": true }, "value": { "type": "number", "description": "Value to be paid in installments." }, "isDefault": { "type": "boolean", "description": "Indicates whether the payment system is automatically applied by default.", "default": false }, "self": { "$ref": "#/components/schemas/Self" } } }, "Self": { "required": [ "href" ], "type": "object", "description": "Object containing the payment system reference route.", "properties": { "href": { "type": "string", "description": "Payment system reference route." } } }, "Option": { "required": [ "ruleId", "quantity", "value", "interestRate", "isExternalInstallmentService", "interestTax" ], "type": "object", "description": "Installment options information.", "properties": { "ruleId": { "type": "string", "description": "Rule identification.", "nullable": true }, "quantity": { "type": "integer", "description": "Number of installments." }, "value": { "type": "number", "description": "Value of each installment." }, "interestRate": { "type": "number", "description": "Interest rate (percent 0.1 = 10%)." }, "isExternalInstallmentService": { "type": "number", "description": "Indicates the external installment system (if applicable).", "nullable": true }, "interestTax": { "type": "number", "description": "Interest tax (percent 0.1 = 10%).", "nullable": true } } }, "InvalidRequestValue": { "required": [ "error" ], "type": "object", "description": "Installments options response body information.", "properties": { "error": { "required": [ "code", "message", "exception" ], "type": "object", "description": "Error information.", "properties": { "code": { "type": "string", "description": "Error code." }, "message": { "type": "string", "description": "Error message." }, "exception": { "type": "string", "description": "Exception information.", "nullable": true } } } } }, "InsertAffiliationRequest": { "type": "object", "description": "Insert new affiliation request body information.", "required": [ "implementation", "name", "configuration", "isdelivered", "isConfigured" ], "properties": { "implementation": { "type": "string", "description": "Provider implementation class name.", "example": "Vtex.PaymentGateway.Connectors.CieloV3Connector" }, "name": { "type": "string", "description": "Provider name.", "example": "CieloV3 - Test" }, "configuration": { "type": "array", "description": "Array containing provider configuration information.", "items": { "type": "object", "description": "Provider configuration information.", "required": [ "name", "value" ], "properties": { "name": { "type": "string", "description": "Configuration parameter name.", "example": "MerchantId" }, "value": { "type": "string", "description": "Configuration parameter value.", "example": "sampleData" } } } }, "isdelivered": { "type": "boolean", "description": "Indicates whether the provider is published and available for use.", "example": true }, "isConfigured": { "type": "boolean", "description": "Indicates whether the provider is configured.", "example": true } }, "example": { "implementation": "Vtex.PaymentGateway.Connectors.CieloV3Connector", "name": "CieloV3 - Test", "configuration": [ { "name": "HowTo", "value": "https://developercielo.github.io/payment-method-enablement/" }, { "name": "MerchantId", "value": "sampleData" }, { "name": "MerchantKey", "value": "**********" }, { "name": "softDescriptor", "value": "teste" }, { "name": "bankInvoiceProvider", "value": "Disabled" }, { "name": "bankIDebitProvider", "value": "Disabled" }, { "name": "useEarlySecurityCapture", "value": "0" }, { "name": "isProduction", "value": "false" }, { "name": "bankDebitProvider", "value": "Disabled" }, { "name": "Registered", "value": "false" } ], "isdelivered": true, "isConfigured": true } }, "UpdateAffiliationRequest": { "type": "object", "description": "Update affiliation by ID request body information.", "required": [ "id", "implementation", "name", "configuration", "isdelivered", "isConfigured" ], "properties": { "id": { "type": "string", "description": "Provider identification.", "example": "fg8b4ea5-0b24-47dc-971e-2f6635ea1f14" }, "implementation": { "type": "string", "description": "Provider implementation class name.", "example": "Vtex.PaymentGateway.Connectors.CieloV3Connector" }, "name": { "type": "string", "description": "Provider name.", "example": "CieloV3 - Test" }, "configuration": { "type": "array", "description": "Array containing provider configuration information.", "items": { "type": "object", "description": "Provider configuration information.", "required": [ "name", "value", "valueKey" ], "properties": { "name": { "type": "string", "description": "Configuration parameter name.", "example": "MerchantId" }, "value": { "type": "string", "description": "Configuration parameter value.", "example": "sampleData" }, "valueKey": { "type": "string", "description": "Value key information.", "example": "valuekey_1", "nullable": true } } } }, "isdelivered": { "type": "boolean", "description": "Indicates whether the provider is published and available for use.", "example": true }, "isConfigured": { "type": "boolean", "description": "Indicates whether the provider is configured.", "example": true } }, "example": { "id": "fg8b4ea5-0b24-47dc-971e-2f6635ea1f14", "implementation": "Vtex.PaymentGateway.Connectors.CieloV3Connector", "name": "CieloV3 - Test", "configuration": [ { "name": "HowTo", "value": "https://developercielo.github.io/payment-method-enablement/", "valueKey": null }, { "name": "MerchantId", "value": "sampleData", "valueKey": null }, { "name": "MerchantKey", "value": "**********", "valueKey": null }, { "name": "softDescriptor", "value": "teste", "valueKey": null }, { "name": "bankInvoiceProvider", "value": "Disabled", "valueKey": null }, { "name": "bankIDebitProvider", "value": "Disabled", "valueKey": null }, { "name": "useEarlySecurityCapture", "value": "0", "valueKey": null }, { "name": "isProduction", "value": "false", "valueKey": null }, { "name": "bankDebitProvider", "value": "Disabled", "valueKey": null }, { "name": "Registered", "value": "false", "valueKey": null } ], "isdelivered": true, "isConfigured": true } }, "AffiliationResponse": { "type": "object", "description": "Affiliation by ID response body information.", "required": [ "id", "implementation", "name", "configuration", "isdelivered", "isConfigured" ], "properties": { "id": { "type": "string", "description": "Provider identification." }, "implementation": { "type": "string", "description": "Provider implementation class name." }, "name": { "type": "string", "description": "Provider name." }, "configuration": { "type": "array", "description": "Array containing provider configuration information.", "items": { "type": "object", "description": "Provider configuration information.", "required": [ "name", "value", "valueKey" ], "properties": { "name": { "type": "string", "description": "Configuration parameter name." }, "value": { "type": "string", "description": "Configuration parameter value." }, "valueKey": { "type": "string", "description": "Value key information.", "nullable": true } } } }, "isdelivered": { "type": "boolean", "description": "Indicates whether the provider is published and available for use.", "example": true }, "isConfigured": { "type": "boolean", "description": "Indicates whether the provider is configured.", "example": true } } }, "GetRulesResponse": { "required": [ "id", "name", "salesChannels", "paymentSystem", "connector", "issuer", "antifraud", "installmentOptions", "isSelfAuthorized", "requiresAuthentication", "enabled", "installmentsService", "isDefault", "beginDate", "endDate", "condition", "multiMerchantList", "country", "dateIntervals" ], "type": "array", "description": "Array containing payment rules information.", "items": { "type": "object", "description": "Payment rules information.", "properties": { "id": { "type": "string", "description": "Rule identification.", "example": "9e11ed95-4b7f-4445-a53e-2512f260ff1c" }, "name": { "type": "string", "description": "Rule name.", "example": "American Express" }, "salesChannels": { "$ref": "#/components/schemas/SalesChannel" }, "paymentSystem": { "$ref": "#/components/schemas/PaymentSystem" }, "connector": { "$ref": "#/components/schemas/Connector" }, "issuer": { "$ref": "#/components/schemas/Issuer" }, "antifraud": { "$ref": "#/components/schemas/Antifraud" }, "installmentOptions": { "required": [ "dueDateType", "interestRateMethod", "minimumInstallmentValue", "installments" ], "type": "object", "description": "Installment options information.", "nullable": true, "properties": { "dueDateType": { "type": "number", "description": "Indicates whether the billing date will be at the end (0) or beginning of the period (1).", "enum": [ 0, 1 ] }, "interestRateMethod": { "type": "number", "description": "Indicates the type of interest to calculate the value of the installments (Compound Interest = `null` or `0`, Simple Interest Rate with Tax = `1` and Single Interest = `2`).", "enum": [ null, 0, 1, 2 ], "nullable": true }, "minimumInstallmentValue": { "type": "number", "description": "Minimum value of each installment." }, "installments": { "type": "array", "description": "Array containing installments information.", "items": { "required": [ "ruleId", "quantity", "value", "interestRate", "isExternalInstallmentService", "interestTax" ], "type": "object", "description": "Installments information.", "properties": { "ruleId": { "type": "string", "description": "Rule identification.", "example": "fe6c470b-f80b-4bb1-a75c-378617f8767a", "nullable": true }, "quantity": { "type": "integer", "description": "Number of installments.", "example": 1 }, "value": { "type": "number", "description": "Value of each installment." }, "interestRate": { "type": "number", "description": "Interest rate (percent 0.1 = 10%)." }, "isExternalInstallmentService": { "type": "number", "description": "Indicates the external installment system (if applicable).", "nullable": true }, "interestTax": { "type": "number", "description": "Interest tax (percent 0.1 = 10%).", "nullable": true } } } } } }, "isSelfAuthorized": { "type": "boolean", "description": "Indicates whether the payment is automatically authorized.", "example": true, "nullable": true }, "requiresAuthentication": { "type": "boolean", "description": "Indicates whether it is necessary to log in to make the payment.", "example": true, "nullable": true }, "enabled": { "type": "boolean", "description": "Indicates whether the rule is enabled in the store.", "example": true }, "installmentsService": { "type": "boolean", "description": "Indicates whether any specific type of installment service is used.", "example": false }, "isDefault": { "type": "boolean", "description": "Indicates whether this rule should be considered the default for a given payment condition.", "example": false, "nullable": true }, "beginDate": { "type": "string", "description": "Rule start date in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format (`YYYY-MM-DDThh:mm:ss.fff`), if applicable.", "example": "2023-12-10T17:00:00Z", "nullable": true }, "endDate": { "type": "string", "description": "Rule end date in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format (`YYYY-MM-DDThh:mm:ss.fff`), if applicable.", "example": "2023-12-12T17:00:00Z", "nullable": true }, "condition": { "required": [ "id", "pullRate", "name" ], "type": "object", "description": "Commercial condition information.", "nullable": true, "properties": { "id": { "type": "string", "description": "Commercial condition identification.", "example": "1" }, "pullRate": { "type": "number", "description": "Indicates the minimum percentage of SKUs required in the cart using this commercial condition for it to be activated.", "example": 0.0 }, "name": { "type": "string", "description": "Commercial condition information.", "example": "Commercial_condition_1", "nullable": true } } }, "multiMerchantList": { "type": "array", "description": "Indicates the names of the accounts to which the rule is being applied exclusively.", "items": { "type": "string", "description": "Account names.", "example": "test_store_1" }, "nullable": true }, "country": { "required": [ "name", "isoCode" ], "type": "object", "description": "Information about rule application in a country.", "nullable": true, "properties": { "name": { "type": "string", "description": "Country name.", "example": "Brazil", "nullable": true }, "isoCode": { "type": "string", "description": "Country code (ISO 3166 alpha-2).", "example": "BRA" } } }, "dateIntervals": { "type": "array", "description": "Array containing information about the periods (days and hours) in which the rule is enabled.", "nullable": true, "items": { "required": [ "start", "end" ], "type": "object", "description": "Rule enablement period information.", "properties": { "start": { "type": "string", "description": "Time, days of the week, and GMT time zone in which the rule is activated. This data is available in [CRON format](https://en.wikipedia.org/wiki/Cron).", "example": "* * 11 * * 1,3,4 * -0300" }, "end": { "type": "string", "description": "Time, days of the week and GMT time zone in which the rule is deactivated. This data is available in [CRON format](https://en.wikipedia.org/wiki/Cron).", "example": "* * 18 * * 1,3,4 * -0300" } } } }, "externalInterest": { "type": "boolean", "description": "Indicates whether interest can be calculated externally.", "example": false }, "minimumValue": { "type": "number", "description": "Minimum payment transaction amount for the rule to be applied.", "nullable": true }, "deadlines": { "type": "array", "description": "Array containing information about the payment deadlines (applicable for credit payment method).", "items": { "type": "object", "description": "Payment deadlines information.", "required": [ "paymentOptions" ], "properties": { "paymentOptions": { "type": "array", "description": "Array containing payment options information.", "items": { "required": [ "days", "interestRate" ], "type": "object", "description": "Payment options information.", "properties": { "days": { "type": "number", "description": "Deadline in days to make payment.", "example": 30 }, "interestRate": { "type": "number", "description": "Interest rate applied (in percentage, e.g. `3.0` means 3%).", "example": 0.0 } } } } } } }, "cobrand": { "required": [ "name" ], "type": "object", "description": "Information about the cobranded card.", "properties": { "name": { "type": "string", "description": "Card name.", "example": "Cobrand_Test", "nullable": true } } }, "cardLevel": { "required": [ "name" ], "type": "object", "description": "Information about the card category.", "properties": { "name": { "type": "string", "description": "Card category name (e.g. standard, gold, premium).", "example": "premium", "nullable": true } } }, "excludedBinsRanges": { "type": "number", "description": "Range of card bins excluded from application of this rule.", "nullable": true } } } }, "RulesRequest": { "required": [ "id", "name", "salesChannels", "paymentSystem", "connector", "issuer", "antifraud", "installmentOptions", "isSelfAuthorized", "requiresAuthentication", "enabled", "installmentsService", "isDefault", "beginDate", "endDate", "condition", "multiMerchantList", "country", "dateIntervals" ], "type": "object", "description": "Payment rules information.", "properties": { "id": { "type": "string", "description": "Rule identification.", "example": "9e11ed95-4b7f-4445-a53e-2512f260ff1c" }, "name": { "type": "string", "description": "Rule name.", "example": "American Express" }, "salesChannels": { "$ref": "#/components/schemas/SalesChannel" }, "paymentSystem": { "$ref": "#/components/schemas/PaymentSystem" }, "connector": { "$ref": "#/components/schemas/Connector" }, "issuer": { "$ref": "#/components/schemas/Issuer" }, "antifraud": { "$ref": "#/components/schemas/Antifraud" }, "installmentOptions": { "required": [ "dueDateType", "interestRateMethod", "minimumInstallmentValue", "installments" ], "type": "object", "description": "Installment options information.", "nullable": true, "properties": { "dueDateType": { "type": "number", "description": "Indicates whether the billing date will be at the end (0) or beginning of the period (1).", "enum": [ 0, 1 ] }, "interestRateMethod": { "type": "number", "description": "Indicates the type of interest to calculate the value of the installments (Compound Interest = `null` or `0`, Simple Interest Rate with Tax = `1` and Single Interest = `2`).", "enum": [ null, 0, 1, 2 ], "nullable": true }, "minimumInstallmentValue": { "type": "number", "description": "Minimum value of each installment." }, "installments": { "type": "array", "description": "Array containing installments information.", "items": { "required": [ "ruleId", "quantity", "value", "interestRate", "isExternalInstallmentService", "interestTax" ], "type": "object", "description": "Installments information.", "properties": { "ruleId": { "type": "string", "description": "Rule identification.", "example": "fe6c470b-f80b-4bb1-a75c-378617f8767a", "nullable": true }, "quantity": { "type": "integer", "description": "Number of installments.", "example": 1 }, "value": { "type": "number", "description": "Value of each installment." }, "interestRate": { "type": "number", "description": "Interest rate (percent 0.1 = 10%)." }, "isExternalInstallmentService": { "type": "number", "description": "Indicates the external installment system (if applicable).", "nullable": true }, "interestTax": { "type": "number", "description": "Interest tax (percent 0.1 = 10%).", "nullable": true } } } } } }, "isSelfAuthorized": { "type": "boolean", "description": "Indicates whether the payment is automatically authorized.", "example": true, "nullable": true }, "requiresAuthentication": { "type": "boolean", "description": "Indicates whether it is necessary to log in to make the payment.", "example": true, "nullable": true }, "enabled": { "type": "boolean", "description": "Indicates whether the rule is enabled in the store.", "example": true }, "installmentsService": { "type": "boolean", "description": "Indicates whether any specific type of installment service is used.", "example": false }, "isDefault": { "type": "boolean", "description": "Indicates whether this rule should be considered the default for a given payment condition.", "example": false, "nullable": true }, "beginDate": { "type": "string", "description": "Rule start date in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format (`YYYY-MM-DDThh:mm:ss.fff`), if applicable.", "example": "2023-12-10T17:00:00Z", "nullable": true }, "endDate": { "type": "string", "description": "Rule end date in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format (`YYYY-MM-DDThh:mm:ss.fff`), if applicable.", "example": "2023-12-12T17:00:00Z", "nullable": true }, "condition": { "required": [ "id", "pullRate", "name" ], "type": "object", "description": "Commercial condition information.", "nullable": true, "properties": { "id": { "type": "string", "description": "Commercial condition identification.", "example": "1" }, "pullRate": { "type": "number", "description": "Indicates the minimum percentage of SKUs required in the cart using this commercial condition for it to be activated.", "example": 0.0 }, "name": { "type": "string", "description": "Commercial condition information.", "example": "Commercial_condition_1", "nullable": true } } }, "multiMerchantList": { "type": "array", "description": "Indicates the names of the accounts to which the rule is being applied exclusively.", "items": { "type": "string", "description": "Account names.", "example": "test_store_1" }, "nullable": true }, "country": { "required": [ "name", "isoCode" ], "type": "object", "description": "Information about rule application in a country.", "nullable": true, "properties": { "name": { "type": "string", "description": "Country name.", "example": "Brazil", "nullable": true }, "isoCode": { "type": "string", "description": "Country code (ISO 3166 alpha-2).", "example": "BRA" } } }, "dateIntervals": { "type": "array", "description": "Array containing information about the periods (days and hours) in which the rule is enabled.", "nullable": true, "items": { "required": [ "start", "end" ], "type": "object", "description": "Rule enablement period information.", "properties": { "start": { "type": "string", "description": "Time, days of the week, and GMT time zone in which the rule is activated. This data is available in [CRON format](https://en.wikipedia.org/wiki/Cron).", "example": "* * 11 * * 1,3,4 * -0300" }, "end": { "type": "string", "description": "Time, days of the week and GMT time zone in which the rule is deactivated. This data is available in [CRON format](https://en.wikipedia.org/wiki/Cron).", "example": "* * 18 * * 1,3,4 * -0300" } } } }, "externalInterest": { "type": "boolean", "description": "Indicates whether interest can be calculated externally.", "example": false }, "minimumValue": { "type": "number", "description": "Minimum payment transaction amount for the rule to be applied.", "nullable": true }, "deadlines": { "type": "array", "description": "Array containing information about the payment deadlines (applicable for credit payment method).", "items": { "type": "object", "description": "Payment deadlines information.", "required": [ "paymentOptions" ], "properties": { "paymentOptions": { "type": "array", "description": "Array containing payment options information.", "items": { "required": [ "days", "interestRate" ], "type": "object", "description": "Payment options information.", "properties": { "days": { "type": "number", "description": "Deadline in days to make payment.", "example": 30 }, "interestRate": { "type": "number", "description": "Interest rate applied (in percentage, e.g. `3.0` means 3%).", "example": 0.0 } } } } } } }, "cobrand": { "required": [ "name" ], "type": "object", "description": "Information about the cobranded card.", "properties": { "name": { "type": "string", "description": "Card name.", "example": "Cobrand_Test", "nullable": true } } }, "cardLevel": { "required": [ "name" ], "type": "object", "description": "Information about the card category.", "properties": { "name": { "type": "string", "description": "Card category name (e.g. standard, gold, premium).", "example": "premium", "nullable": true } } }, "excludedBinsRanges": { "type": "number", "description": "Range of card bins excluded from application of this rule.", "nullable": true } } }, "InsertRuleRequest": { "required": [ "name", "salesChannels", "paymentSystem", "connector", "issuer", "antifraud", "installmentOptions", "isSelfAuthorized", "requiresAuthentication", "enabled", "installmentsService", "isDefault", "beginDate", "endDate", "condition", "multiMerchantList", "country", "dateIntervals" ], "type": "object", "description": "New payment rule request body information.", "properties": { "name": { "type": "string", "description": "Rule name.", "example": "Test_API_2" }, "salesChannels": { "$ref": "#/components/schemas/SalesChannel" }, "paymentSystem": { "$ref": "#/components/schemas/PaymentSystem" }, "connector": { "$ref": "#/components/schemas/Connector" }, "issuer": { "$ref": "#/components/schemas/Issuer" }, "antifraud": { "$ref": "#/components/schemas/Antifraud" }, "installmentOptions": { "required": [ "dueDateType", "interestRateMethod", "minimumInstallmentValue", "installments" ], "type": "object", "description": "Installment options information.", "nullable": true, "properties": { "dueDateType": { "type": "number", "description": "Indicates whether the billing date will be at the end (0) or beginning of the period (1).", "enum": [ 0, 1 ] }, "interestRateMethod": { "type": "number", "description": "Indicates the type of interest to calculate the value of the installments (Compound Interest = `null` or `0`, Simple Interest Rate with Tax = `1` and Single Interest = `2`).", "enum": [ null, 0, 1, 2 ], "nullable": true }, "minimumInstallmentValue": { "type": "number", "description": "Minimum value of each installment." }, "installments": { "type": "array", "description": "Array containing installments information.", "items": { "required": [ "ruleId", "quantity", "value", "interestRate", "isExternalInstallmentService", "interestTax" ], "type": "object", "description": "Installments information.", "properties": { "ruleId": { "type": "string", "description": "Rule identification.", "example": "fe6c470b-f80b-4bb1-a75c-378617f8767a", "nullable": true }, "quantity": { "type": "integer", "description": "Number of installments.", "example": 1 }, "value": { "type": "number", "description": "Value of each installment." }, "interestRate": { "type": "number", "description": "Interest rate (percent 0.1 = 10%)." }, "isExternalInstallmentService": { "type": "number", "description": "Indicates the external installment system (if applicable).", "nullable": true }, "interestTax": { "type": "number", "description": "Interest tax (percent 0.1 = 10%).", "nullable": true } } } } } }, "isSelfAuthorized": { "type": "boolean", "description": "Indicates whether the payment is automatically authorized.", "example": true, "nullable": true }, "requiresAuthentication": { "type": "boolean", "description": "Indicates whether it is necessary to log in to make the payment.", "example": true, "nullable": true }, "enabled": { "type": "boolean", "description": "Indicates whether the rule is enabled in the store.", "example": false }, "installmentsService": { "type": "boolean", "description": "Indicates whether any specific type of installment service is used.", "example": false }, "isDefault": { "type": "boolean", "description": "Indicates whether this rule should be considered the default for a given payment condition.", "example": false, "nullable": true }, "beginDate": { "type": "string", "description": "Rule start date in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format (`YYYY-MM-DDThh:mm:ss.fff`), if applicable.", "example": "2023-12-10T17:00:00Z", "nullable": true }, "endDate": { "type": "string", "description": "Rule end date in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format (`YYYY-MM-DDThh:mm:ss.fff`), if applicable.", "example": "2023-12-12T17:00:00Z", "nullable": true }, "condition": { "required": [ "id", "pullRate", "name" ], "type": "object", "description": "Commercial condition information.", "nullable": true, "properties": { "id": { "type": "string", "description": "Commercial condition identification.", "example": "1" }, "pullRate": { "type": "number", "description": "Indicates the minimum percentage of SKUs required in the cart using this commercial condition for it to be activated.", "example": 0.0 }, "name": { "type": "string", "description": "Commercial condition information.", "example": "Commercial_condition_1", "nullable": true } } }, "multiMerchantList": { "type": "array", "description": "Indicates the names of the accounts to which the rule is being applied exclusively.", "items": { "type": "string", "description": "Account names.", "example": "test_store_1" }, "nullable": true }, "country": { "required": [ "name", "isoCode" ], "type": "object", "description": "Information about rule application in a country.", "nullable": true, "properties": { "name": { "type": "string", "description": "Country name.", "example": "Brazil", "nullable": true }, "isoCode": { "type": "string", "description": "Country code (ISO 3166 alpha-2).", "example": "BRA" } } }, "dateIntervals": { "type": "array", "description": "Array containing information about the periods (days and hours) in which the rule is enabled.", "nullable": true, "items": { "required": [ "start", "end" ], "type": "object", "description": "Rule enablement period information.", "properties": { "start": { "type": "string", "description": "Time, days of the week, and GMT time zone in which the rule is activated. This data is available in [CRON format](https://en.wikipedia.org/wiki/Cron).", "example": "* * 11 * * 1,3,4 * -0300" }, "end": { "type": "string", "description": "Time, days of the week and GMT time zone in which the rule is deactivated. This data is available in [CRON format](https://en.wikipedia.org/wiki/Cron).", "example": "* * 18 * * 1,3,4 * -0300" } } } }, "externalInterest": { "type": "boolean", "description": "Indicates whether interest can be calculated externally.", "example": false }, "minimumValue": { "type": "number", "description": "Minimum payment transaction amount for the rule to be applied.", "nullable": true }, "deadlines": { "type": "array", "description": "Array containing information about the payment deadlines (applicable for credit payment method).", "items": { "type": "object", "description": "Payment deadlines information.", "required": [ "paymentOptions" ], "properties": { "paymentOptions": { "type": "array", "description": "Array containing payment options information.", "items": { "required": [ "days", "interestRate" ], "type": "object", "description": "Payment options information.", "properties": { "days": { "type": "number", "description": "Deadline in days to make payment.", "example": 30 }, "interestRate": { "type": "number", "description": "Interest rate applied (in percentage, e.g. `3.0` means 3%).", "example": 0.0 } } } } } } }, "cobrand": { "required": [ "name" ], "type": "object", "description": "Information about the cobranded card.", "properties": { "name": { "type": "string", "description": "Card name.", "example": "Cobrand_Test", "nullable": true } } }, "cardLevel": { "required": [ "name" ], "type": "object", "description": "Information about the card category.", "properties": { "name": { "type": "string", "description": "Card category name (e.g. standard, gold, premium).", "example": "premium", "nullable": true } } }, "excludedBinsRanges": { "type": "number", "description": "Range of card bins excluded from application of this rule.", "nullable": true } } }, "SalesChannel": { "type": "array", "description": "Array containing information about the Sales channel.", "items": { "type": "object", "description": "Sales channel information.", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "Sales channel identification.", "example": "1" } } } }, "PaymentSystem": { "required": [ "id", "name", "implementation" ], "type": "object", "description": "Payment system information.", "properties": { "id": { "type": "number", "description": "Payment system identification.", "example": 1 }, "name": { "type": "string", "description": "Payment system name.", "example": "CieloV3 - Test" }, "implementation": { "type": "string", "description": "Payment system implementation class name.", "example": "Vtex.PaymentGateway.Connectors.CieloV3Connector", "nullable": true } } }, "Connector": { "required": [ "implementation", "affiliationId" ], "type": "object", "description": "Connector (payment provider) information.", "nullable": true, "properties": { "implementation": { "type": "string", "description": "Connector (payment provider) implementation class name.", "example": "Vtex.PaymentGateway.Connectors.CieloV3Connector" }, "affiliationId": { "type": "string", "description": "Affiliation connector (payment provider) identification.", "example": "0a8488e6-0c30-4150-be96-b0dcaaa6a0cd" } } }, "Issuer": { "required": [ "name" ], "type": "object", "description": "Card issuer information.", "properties": { "name": { "type": "string", "description": "Card issuer name.", "example": "barclays", "nullable": true } } }, "Antifraud": { "required": [ "implementation", "affiliationId" ], "type": "object", "description": "Anti-fraud information.", "nullable": true, "properties": { "implementation": { "type": "string", "description": "Connector (anti-fraud provider) implementation class name.", "example": "Vtex.PaymentGateway.Connectors.ClearSaleConnector", "nullable": true }, "affiliationId": { "type": "string", "description": "Affiliation connector (anti-fraud provider) identification.", "example": "0a8488e6-0c30-4150-be96-b0dcaaa6a0cd", "nullable": true } } }, "PaymentSystemsResponse": { "required": [ "id", "name", "requiresDocument", "implementation", "connectorImplementation", "antifraudConnectorImplementation", "groupName", "redirect", "isCustom", "isSelfAuthorized", "requiresAuthentication", "allowInstallments", "allowBinExclusion", "allowMultiple", "allowIssuer", "allowCountry", "allowCommercialPolicy", "allowCommercialCondition", "allowPeriod", "isAvailable", "description", "supportRecurrence", "validator", "appDependencies", "displayDocument", "dueDate", "allowNotification", "affiliationId", "availablePayments", "dueDateMinutes" ], "type": "object", "description": "Available payment methods response body information.", "properties": { "id": { "type": "number", "description": "Payment method identification." }, "name": { "type": "string", "description": "Payment method name." }, "requiresDocument": { "type": "boolean", "description": "Indicates whether a document is required." }, "implementation": { "type": "string", "description": "Payment method implementation class name." }, "connectorImplementation": { "type": "string", "description": "Connector (payment provider) implementation class name." }, "antifraudConnectorImplementation": { "type": "string", "description": "Connector (anti-fraud provider) implementation class name.", "nullable": true }, "groupName": { "type": "string", "description": "Payment group name." }, "redirect": { "type": "boolean", "description": "Indicates whether the payment method allows redirection." }, "isCustom": { "type": "boolean", "description": "Indicates whether it is custom." }, "isSelfAuthorized": { "type": "boolean", "description": "Indicates whether the payment is automatically authorized." }, "requiresAuthentication": { "type": "boolean", "description": "Indicates whether it is necessary to log in to make the payment." }, "allowInstallments": { "type": "boolean", "description": "Indicates whether the payment method allows installments." }, "allowBinExclusion": { "type": "boolean", "description": "Indicates whether it is possible to restrict the use of specific BIN codes (only applicable for cards)." }, "allowMultiple": { "type": "boolean", "description": "Indicates whether the method allows multiple payments. Example of `false`: debit card." }, "allowIssuer": { "type": "boolean", "description": "Indicates whether it is possible to identify the name of the bank responsible for issuing the card." }, "allowCountry": { "type": "boolean", "description": "Indicates whether it is possible to restrict a payment rule by the country where the purchase is made." }, "allowCommercialPolicy": { "type": "boolean", "description": "Indicates whether to restrict a payment rule by commercial policy type." }, "allowCommercialCondition": { "type": "boolean", "description": "Indicates whether to restrict a payment rule by commercial condition type." }, "allowPeriod": { "type": "boolean", "description": "Indicates whether it is possible to restrict a period for making the payment." }, "isAvailable": { "type": "boolean", "description": "Indicates whether the payment method is available for use." }, "description": { "type": "string", "description": "Description of the payment method.", "nullable": true }, "supportRecurrence": { "type": "boolean", "description": "Indicates whether the payment method supports recurrence." }, "validator": { "$ref": "#/components/schemas/Validator" }, "appDependencies": { "type": "string", "description": "App dependencies information.", "nullable": true }, "displayDocument": { "type": "boolean", "description": "Indicates whether a document is shown." }, "dueDate": { "type": "string", "description": "Payment due date." }, "allowNotification": { "type": "boolean", "description": "Indicates the possibility of payment notification (used by bank invoices and notes payable)." }, "affiliationId": { "type": "string", "description": "Affiliation connector (payment provider) identification.", "nullable": true }, "availablePayments": { "type": "string", "description": "Information about payment availability.", "nullable": true }, "dueDateMinutes": { "type": "number", "description": "Amount of time (in minutes) until the payment date (`dueDate`)." } } }, "Validator": { "required": [ "regex", "mask", "cardCodeMask", "cardCodeRegex", "weights", "useCvv", "useExpirationDate", "useCardHolderName", "useBillingAddress", "validCardLengths" ], "type": "object", "description": "Validator information.", "properties": { "regex": { "type": "string", "description": "[Regex](https://regexr.com/) information.", "nullable": true }, "mask": { "type": "string", "description": "Validator mask.", "nullable": true }, "cardCodeMask": { "type": "string", "description": "Card code regular mask.", "nullable": true }, "cardCodeRegex": { "type": "string", "description": "Card code regular expression.", "nullable": true }, "weights": { "type": "array", "description": "Array containing weigths information.", "items": { "type": "integer", "description": "Weigths information." }, "nullable": true }, "useCvv": { "type": "boolean", "description": "Indicates whether it is necessary to use the CVV code to complete a transaction with payment made by card." }, "useExpirationDate": { "type": "boolean", "description": "Indicates whether it is necessary to use the expiration date to complete a card payment transaction." }, "useCardHolderName": { "type": "boolean", "description": "Indicates whether it is necessary to use the card holder name to complete a payment transaction made by card." }, "useBillingAddress": { "type": "boolean", "description": "Indicates whether it is necessary to use the billing address to complete a card payment transaction." }, "validCardLengths": { "type": "string", "description": "Information about valid card lengths.", "nullable": true } } }, "1.CreateanewtransactionRequest": { "required": [ "value", "referenceId", "channel", "salesChannel" ], "type": "object", "description": "New transaction request body information.", "properties": { "value": { "type": "number", "description": "Transaction value. The value must be described without using separation for decimals, e.g. for a transaction with a value equal to 201.50, send 20150.", "example": 20000 }, "referenceId": { "type": "string", "description": "Identification number that relates the transaction to a purchase order.", "example": "1234567" }, "channel": { "type": "string", "description": "Store where the transaction was initiated.", "example": "cosmetics2" }, "urn": { "type": "string", "description": "[URN](https://en.wikipedia.org/wiki/Uniform_Resource_Name) information.", "example": "urn:amazon:webservices:clientvpn", "nullable": true }, "salesChannel": { "type": "string", "description": "Sales channel information.", "example": "1" } } }, "StartTransactionResponse": { "required": [ "id", "transactionId", "referenceKey", "interactions", "settlements", "payments", "refunds", "cancellations", "capabilities", "timeoutStatus", "totalRefunds", "status", "value", "receiverUri", "startDate", "authorizationToken", "authorizationDate", "commitmentToken", "commitmentDate", "refundingToken", "refundingDate", "cancelationToken", "cancelationDate", "fields", "ipAddress", "sessionId", "macId", "vtexFingerprint", "chargeback", "whiteSignature", "owner", "orderId", "userAgent", "acceptHeader", "antifraudTid", "antifraudResponse", "antifraudReference", "antifraudAffiliationId", "channel", "salesChannel", "urn", "softDescriptor", "markedForRecurrence", "buyer" ], "type": "object", "description": "New transaction response body information.", "properties": { "id": { "type": "string", "description": "Transaction identification." }, "transactionId": { "type": "string", "description": "Transaction identification (same value of the `id` field)." }, "referenceKey": { "type": "string", "description": "Identification number that relates the transaction to a purchase order. It can be also used for anti-fraud to identify the transaction." }, "interactions": { "$ref": "#/components/schemas/Interactions" }, "settlements": { "$ref": "#/components/schemas/Settlements" }, "payments": { "$ref": "#/components/schemas/Payments" }, "refunds": { "$ref": "#/components/schemas/Refunds" }, "cancellations": { "$ref": "#/components/schemas/Cancellations" }, "capabilities": { "$ref": "#/components/schemas/Capabilities" }, "timeoutStatus": { "type": "number", "description": "Field that represents the possible transaction timeout statuses. Possible statuses and meanings: `0` = NotStarted, `1` = CancellingOrFinishing, `2` = CancellingOrFinishingByTimeout, `3` = CancelledOrFinished and `4` = TriesExceeded.", "enum": [ 0, 1, 2, 3, 4 ] }, "totalRefunds": { "type": "number", "description": "Total refunded transaction amount." }, "status": { "type": "string", "description": "Transaction status." }, "value": { "type": "number", "description": "Transaction value." }, "receiverUri": { "type": "string", "description": "Receiver [URI](https://en.wikipedia.org/wiki/Uniform_Resource_Identifier) information.", "nullable": true }, "startDate": { "type": "string", "description": "Transaction start date." }, "authorizationToken": { "type": "string", "description": "Transaction authorization token.", "nullable": true }, "authorizationDate": { "type": "string", "description": "Transaction authorization date.", "nullable": true }, "commitmentToken": { "type": "string", "description": "Transaction completion token.", "nullable": true }, "commitmentDate": { "type": "string", "description": "Transaction completion date.", "nullable": true }, "refundingToken": { "type": "string", "description": "Transaction refund token.", "nullable": true }, "refundingDate": { "type": "string", "description": "Transaction refund date.", "nullable": true }, "cancelationToken": { "type": "string", "description": "Transaction cancellation token.", "nullable": true }, "cancelationDate": { "type": "string", "description": "Transaction cancellation date.", "nullable": true }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/Field" }, "description": "Field containing transaction information." }, "ipAddress": { "type": "string", "description": "IP address information.", "nullable": true }, "sessionId": { "type": "string", "description": "Session identification.", "nullable": true }, "macId": { "type": "string", "description": "Random [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) V4 generated when the Request Capture receives a session that does not contain the macID already set. This value is set to the cookie `VtexRCMacIdv7`. The cookie has 1 year of expiration.", "nullable": true }, "vtexFingerprint": { "type": "string", "description": "VTEX fingerprint information.", "nullable": true }, "chargeback": { "type": "string", "description": "Chargeback information.", "nullable": true }, "whiteSignature": { "type": "string", "description": "White signature (anti-fraud list) information.", "nullable": true }, "owner": { "type": "string", "description": "Responsible for transaction request." }, "orderId": { "type": "string", "description": "Order identitication.", "nullable": true }, "userAgent": { "type": "string", "description": "HTTP client used in the transaction.", "nullable": true }, "acceptHeader": { "type": "string", "description": "Type of content accepted in the transaction request header.", "nullable": true }, "antifraudTid": { "type": "string", "description": "Anti-fraud transaction identification.", "nullable": true }, "antifraudResponse": { "type": "string", "description": "Anti-fraud response information.", "nullable": true }, "antifraudReference": { "type": "string", "description": "Anti-fraud reference information.", "nullable": true }, "antifraudAffiliationId": { "type": "string", "description": "Anti-fraud affiliation identification.", "nullable": true }, "channel": { "type": "string", "description": "Store where the transaction was initiated." }, "salesChannel": { "type": "string", "description": "Sales channel information." }, "urn": { "type": "string", "description": "[URN](https://en.wikipedia.org/wiki/Uniform_Resource_Name) information.", "nullable": true }, "softDescriptor": { "type": "string", "description": "Custom field for a transaction that can be displayed on the customer's invoice.", "nullable": true }, "markedForRecurrence": { "type": "boolean", "description": "Indicates whether the payment transaction should be recurring." }, "buyer": { "type": "object", "description": "Buyer information.", "nullable": true, "properties": { "firstName": { "type": "string", "description": "Buyer first name." }, "lastName": { "type": "string", "description": "Buyer last name." }, "documentType": { "type": "string", "description": "Type of the document informed by the buyer." }, "document": { "type": "string", "description": "Document informed by the buyer." }, "email": { "type": "string", "description": "Buyer email address." }, "address": { "type": "string", "description": "Buyer address." }, "phone": { "type": "string", "description": "Buyer phone number." } } } } }, "Interactions": { "required": [ "href" ], "type": "object", "description": "Object containing the reference route of transaction interactions.", "properties": { "href": { "type": "string", "description": "Transaction interaction reference route." } } }, "Settlements": { "required": [ "href" ], "type": "object", "description": "Object containing the reference route of transaction settlements.", "properties": { "href": { "type": "string", "description": "Transaction settlement reference route." } } }, "Payments": { "required": [ "href" ], "type": "object", "description": "Object containing the reference route of transaction payments.", "properties": { "href": { "type": "string", "description": "Transaction payment reference route." } } }, "Refunds": { "required": [ "href" ], "type": "object", "description": "Object containing the reference route of transaction refunds.", "properties": { "href": { "type": "string", "description": "Transaction refund reference route." } } }, "Cancellations": { "required": [ "href" ], "type": "object", "description": "Object containing the reference route of transaction cancellations.", "properties": { "href": { "type": "string", "description": "Transaction cancellation reference route." } } }, "Capabilities": { "required": [ "href" ], "type": "object", "description": "Object containing the reference route of transaction capabilities.", "properties": { "href": { "type": "string", "description": "Transaction capabilities reference route." } } }, "Field": { "required": [ "name", "value" ], "type": "object", "description": "Transaction parameters information.", "properties": { "name": { "type": "string", "description": "Transaction parameter name." }, "value": { "type": "string", "description": "Transaction parameter value." } } }, "Fields": { "required": [ "holderName", "cardNumber", "validationCode", "dueDate", "document", "accountId", "address", "callbackUrl" ], "type": "object", "description": "Fields information.", "properties": { "holderName": { "type": "string", "description": "Card holder name.", "example": "UserTest", "nullable": true }, "cardNumber": { "type": "string", "description": "Card number information.", "example": "111111111111", "nullable": true }, "validationCode": { "type": "string", "description": "CVV code.", "example": "231", "nullable": true }, "dueDate": { "type": "string", "description": "Due date information. The date format is `mm/yy`.", "example": "10/19", "nullable": true }, "document": { "type": "string", "description": "Card holder documentation.", "example": "8041734561", "nullable": true }, "accountId": { "type": "string", "description": "Account identification.", "example": "08134AF761A148B9A5DCE14A81F31DD9", "nullable": true }, "address": { "type": "array", "description": "Array containing customer address information.", "items": { "type": "object", "description": "Customer address information.", "properties": { "addressType": { "type": "string", "description": "Address type.", "example": "Residential" }, "receiverName": { "type": "string", "description": "Name of the receiver.", "example": "Clark Kent" }, "postalCode": { "type": "string", "description": "Postal code information.", "example": "5555555" }, "city": { "type": "string", "description": "City of the address.", "example": "Sao Paulo" }, "state": { "type": "string", "description": "State of the address.", "example": "SP" }, "country": { "type": "string", "description": "Country of the address. ISO three-letter code.", "nullable": true, "example": "BRA" }, "street": { "type": "string", "description": "Street of the address.", "example": "Avenue Splendor Garden" }, "number": { "type": "number", "description": "Number of the address.", "example": 111 }, "neighborhood": { "type": "string", "description": "Neighborhood of the address.", "example": "Sumare" }, "complement": { "type": "string", "description": "Complement to the address.", "example": "House", "nullable": true }, "reference": { "type": "string", "description": "Reference that may help in the location of the address.", "example": "Close to the bank.", "nullable": true }, "geoCoordinates": { "type": "array", "description": "Array containing two floats with geocoordinates, first longitude, then latitude.", "example": [ -47.924747467041016, -15.832582473754883 ], "items": { "type": "number", "description": "Geocoordinates information.", "example": -47.924747467041016 } } } } }, "callbackUrl": { "type": "string", "description": "Callback URL information.", "example": "https://coinshop.vtexpayments.com.br/payment-provider/transactions/900BA26FEAC84332A53AE1007E740DE3/payments/E713830E32764BF99028A0A275841BFC/notification" } } }, "Transaction": { "required": [ "id", "merchantName" ], "type": "object", "description": "Transaction information.", "properties": { "id": { "type": "string", "description": "Transaction identification.", "example": "72E84719BDF14B2FB170B38AD12598C9" }, "merchantName": { "type": "string", "description": "Merchant name.", "example": "cosmetics2" } } }, "Fields1": { "required": [ "name", "value" ], "type": "object", "description": "Payment parameters information.", "properties": { "name": { "type": "string", "description": "Payment parameter name." }, "value": { "type": "string", "description": "Payment parameter value." } } }, "2.SendPaymentsPublicRequest": { "required": [ "paymentSystem", "installments", "currencyCode", "value", "installmentsInterestRate", "installmentsValue", "referenceValue", "fields", "transaction" ], "type": "object", "description": "Send payments information public request body information.", "properties": { "paymentSystem": { "type": "number", "description": "Payment system identification.", "example": 17 }, "installments": { "type": "number", "description": "Number of installments.", "example": 1 }, "currencyCode": { "type": "string", "description": "Currency code in ISO 4217 standard.", "example": "BRL" }, "value": { "type": "number", "description": "Payment value.", "example": 15000 }, "installmentsInterestRate": { "type": "number", "description": "The interest rate.", "example": 0 }, "installmentsValue": { "type": "number", "description": "The value of each installment.", "example": 0 }, "referenceValue": { "type": "number", "description": "Value amount of the payment without interest applied. This value is the same as the `value` field when `installmentsInterestRate` is `0.0`.", "example": 15000 }, "fields": { "$ref": "#/components/schemas/Fields" }, "transaction": { "$ref": "#/components/schemas/Transaction" } } }, "2.SendPaymentsWithSavedCreditCardRequest": { "required": [ "paymentSystem", "installments", "currencyCode", "value", "installmentsInterestRate", "installmentsValue", "referenceValue", "fields", "transaction" ], "type": "object", "description": "Send payments with saved credit card request body information.", "properties": { "paymentSystem": { "type": "number", "description": "Payment system identification.", "example": 4 }, "installments": { "type": "number", "description": "Number of installments.", "example": 1 }, "currencyCode": { "type": "string", "description": "Currency code in ISO 4217 standard.", "example": "BRL" }, "value": { "type": "number", "description": "Payment value.", "example": 30000 }, "installmentsInterestRate": { "type": "number", "description": "The interest rate.", "example": 0 }, "installmentsValue": { "type": "number", "description": "The value of each installment.", "example": 0 }, "referenceValue": { "type": "number", "description": "Value amount of the payment without interest applied. This value is the same as the `value` field when `installmentsInterestRate` is `0.0`.", "example": 30000 }, "fields": { "$ref": "#/components/schemas/Fields3" }, "transaction": { "$ref": "#/components/schemas/Transaction" } } }, "Fields3": { "required": [ "holderName", "cardNumber", "validationCode", "dueDate", "document", "accountId", "address", "callbackUrl" ], "type": "object", "description": "Fields information.", "properties": { "holderName": { "type": "string", "description": "Card holder name.", "example": "UserTest" }, "cardNumber": { "type": "string", "description": "Card number information.", "example": "111111111111" }, "validationCode": { "type": "string", "description": "CVV code.", "example": "231" }, "dueDate": { "type": "string", "description": "Due date information. The date format is `mm/yy`.", "example": "10/19" }, "document": { "type": "string", "description": "Card holder documentation.", "example": "8041734561" }, "accountId": { "type": "string", "description": "Account identification.", "example": "08134AF761A148B9A5DCE14A81F31DD9", "nullable": true }, "address": { "type": "array", "description": "Array containing customer address information.", "items": { "type": "string", "description": "Customer address information.", "example": "Customer address data" }, "nullable": true }, "callbackUrl": { "type": "string", "description": "Callback URL information.", "example": "https://payment-test.myvtex.com/checkout/gatewayCallback/1336650505288/Success", "nullable": true } } }, "4.DoauthorizationRequest": { "required": [ "transactionId", "softDescriptor", "prepareForRecurrency" ], "type": "object", "description": "Authorize new transaction request body information.", "properties": { "transactionId": { "type": "string", "description": "Transaction identification.", "example": "7ECE7DF3EEE14647B05DB904164923E8" }, "softDescriptor": { "type": "string", "description": "Custom field for a transaction that can be displayed on the customer's invoice.", "example": "company_name_description_code", "nullable": true }, "prepareForRecurrency": { "type": "boolean", "description": "Indicates whether the transaction supports recurrence.", "example": false } } }, "TransactionDetailsResponse": { "required": [ "id", "transactionId", "referenceKey", "interactions", "settlements", "payments", "refunds", "cancellations", "capabilities", "timeoutStatus", "totalRefunds", "status", "value", "receiverUri", "startDate", "authorizationToken", "authorizationDate", "commitmentToken", "commitmentDate", "refundingToken", "refundingDate", "cancelationToken", "cancelationDate", "fields", "shopperInteraction", "ipAddress", "sessionId", "macId", "vtexFingerprint", "chargeback", "whiteSignature", "owner", "orderId", "userAgent", "acceptHeader", "antifraudTid", "antifraudResponse", "antifraudReference", "antifraudAffiliationId", "channel", "salesChannel", "urn", "softDescriptor", "markedForRecurrence", "buyer" ], "type": "object", "description": "Transaction details response body information.", "properties": { "id": { "type": "string", "description": "Transaction identification." }, "transactionId": { "type": "string", "description": "Transaction identification (same value of the `id` field)." }, "referenceKey": { "type": "string", "description": "Field used for anti-fraud to identify the transaction." }, "interactions": { "$ref": "#/components/schemas/Interactions" }, "settlements": { "$ref": "#/components/schemas/Settlements" }, "payments": { "$ref": "#/components/schemas/Payments" }, "refunds": { "$ref": "#/components/schemas/Refunds" }, "cancellations": { "$ref": "#/components/schemas/Cancellations" }, "capabilities": { "$ref": "#/components/schemas/Capabilities" }, "timeoutStatus": { "type": "number", "description": "Field that represents the possible transaction timeout statuses. Possible statuses and meanings: `0` = NotStarted, `1` = CancellingOrFinishing, `2` = CancellingOrFinishingByTimeout, `3` = CancelledOrFinished and `4` = TriesExceeded.", "enum": [ 0, 1, 2, 3, 4 ] }, "totalRefunds": { "type": "number", "description": "Total refunded transaction amount." }, "status": { "type": "string", "description": "Transaction status." }, "value": { "type": "number", "description": "Transaction value." }, "receiverUri": { "type": "string", "description": "Receiver [URI](https://en.wikipedia.org/wiki/Uniform_Resource_Identifier) information.", "nullable": true }, "startDate": { "type": "string", "description": "Transaction start date." }, "authorizationToken": { "type": "string", "description": "Transaction authorization token.", "nullable": true }, "authorizationDate": { "type": "string", "description": "Transaction authorization date.", "nullable": true }, "commitmentToken": { "type": "string", "description": "Transaction completion token.", "nullable": true }, "commitmentDate": { "type": "string", "description": "Transaction completion date.", "nullable": true }, "refundingToken": { "type": "string", "description": "Transaction refund token.", "nullable": true }, "refundingDate": { "type": "string", "description": "Transaction refund date.", "nullable": true }, "cancelationToken": { "type": "string", "description": "Transaction cancellation token.", "nullable": true }, "cancelationDate": { "type": "string", "description": "Transaction cancellation date.", "nullable": true }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/Fields1" }, "description": "Field containing information and values of payment parameters." }, "shopperInteraction": { "type": "string", "description": "Transaction origin." }, "ipAddress": { "type": "string", "description": "Ip address information.", "nullable": true }, "sessionId": { "type": "string", "description": "Session identification.", "nullable": true }, "macId": { "type": "string", "description": "Random [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) V4 generated when the Request Capture receives a session that does not contain the macID already set. This value is set to the cookie `VtexRCMacIdv7`. The cookie has 1 year of expiration." }, "vtexFingerprint": { "type": "string", "description": "VTEX fingerprint information.", "nullable": true }, "chargeback": { "type": "string", "description": "Chargeback information.", "nullable": true }, "whiteSignature": { "type": "string", "description": "White signature (anti-fraud list) information.", "nullable": true }, "owner": { "type": "string", "description": "Responsible for transaction request." }, "orderId": { "type": "string", "description": "Order identitication.", "nullable": true }, "userAgent": { "type": "string", "description": "HTTP client used in the transaction." }, "acceptHeader": { "type": "string", "description": "Type of content accepted in the transaction request header." }, "antifraudTid": { "type": "string", "description": "Anti-fraud transaction identification.", "nullable": true }, "antifraudResponse": { "type": "string", "description": "Anti-fraud response information.", "nullable": true }, "antifraudReference": { "type": "string", "description": "Anti-fraud reference information.", "nullable": true }, "antifraudAffiliationId": { "type": "string", "description": "Anti-fraud affiliation identification.", "nullable": true }, "channel": { "type": "string", "description": "Store where the transaction was initiated." }, "salesChannel": { "type": "string", "description": "Sales channel information." }, "urn": { "type": "string", "description": "[URN](https://en.wikipedia.org/wiki/Uniform_Resource_Name) information.", "nullable": true }, "softDescriptor": { "type": "string", "description": "Custom field for a transaction that can be displayed on the customer's invoice.", "nullable": true }, "markedForRecurrence": { "type": "boolean", "description": "Indicates whether the payment transaction should be recurring." }, "buyer": { "type": "object", "description": "Buyer information.", "nullable": true, "properties": { "firstName": { "type": "string", "description": "Buyer first name." }, "lastName": { "type": "string", "description": "Buyer last name." }, "documentType": { "type": "string", "description": "Type of the document informed by the buyer." }, "document": { "type": "string", "description": "Document informed by the buyer." }, "email": { "type": "string", "description": "Buyer email address." }, "address": { "type": "string", "description": "Buyer address." }, "phone": { "type": "string", "description": "Buyer phone number." } } } } }, "TransactionInteractionsResponse": { "required": [ "Id", "PaymentId", "TransactionId", "Source", "Status", "Date", "Message", "Ticks" ], "type": "array", "description": "Array containing transaction interactions information.", "items": { "type": "object", "description": "Transaction interactions response body information.", "properties": { "Id": { "type": "string", "description": "Interaction identification." }, "PaymentId": { "type": "string", "description": "Payment identification.", "nullable": true }, "TransactionId": { "type": "string", "description": "Transaction identification." }, "Source": { "type": "string", "description": "Origin of interaction in the VTEX system." }, "Status": { "type": "string", "description": "Transaction status." }, "Date": { "type": "string", "description": "Date of interaction in the transaction." }, "Message": { "type": "string", "description": "Information about the action performed in the interaction." }, "Ticks": { "type": "number", "description": "[Time span value](https://learn.microsoft.com/en-us/dotnet/api/system.timespan.ticks?view=net-8.0#remarks) information. A Tick is the smallest unit of time, equal to 100 nanoseconds or one ten-millionth of a second." } } } }, "PaymentDetailsResponse": { "required": [ "id", "paymentSystem", "paymentSystemName", "merchantName", "group", "userProfileId", "isCustom", "allowInstallments", "requiresAuthentication", "allowIssuer", "allowNotification", "isAvailable", "description", "authorizationDate", "self", "tid", "returnCode", "returnMessage", "status", "connector", "ConnectorResponses", "connectorResponse", "ShowConnectorResponses", "value", "installmentsInterestRate", "installmentsValue", "referenceValue", "installments", "currencyCode", "provider", "isBillingAddressDifferent", "isRegexValid", "isLuhnValid", "fields", "sheets", "originalPaymentId" ], "type": "object", "description": "Payment details information.", "properties": { "id": { "type": "string", "description": "Payment identification." }, "paymentSystem": { "type": "number", "description": "Payment system identification." }, "paymentSystemName": { "type": "string", "description": "Payment system name." }, "merchantName": { "type": "string", "description": "Merchant name.", "nullable": true }, "group": { "type": "string", "description": "Payment group name." }, "userProfileId": { "type": "string", "description": "Unique ID associated with the customer profile.", "nullable": true }, "isCustom": { "type": "boolean", "description": "Indicates whether it is custom." }, "allowInstallments": { "type": "boolean", "description": "Indicates whether the payment method allows installments." }, "requiresAuthentication": { "type": "boolean", "description": "Indicates whether it is necessary to log in to make the payment." }, "allowIssuer": { "type": "boolean", "description": "Indicates whether it is possible to identify the name of the bank responsible for issuing the card." }, "allowNotification": { "type": "boolean", "description": "Indicates the possibility of payment notification (used by bank invoices and notes payable)." }, "isAvailable": { "type": "boolean", "description": "Indicates whether the payment method is available for use." }, "description": { "type": "string", "description": "Description of the payment method.", "nullable": true }, "authorizationDate": { "type": "string", "description": "Payment authorization date.", "nullable": true }, "self": { "$ref": "#/components/schemas/Self" }, "tid": { "type": "string", "description": "Provider's unique identifier for the transaction.", "nullable": true }, "nsu": { "type": "string", "description": "Provider's unique sequential number for the transaction.", "nullable": true }, "returnCode": { "type": "string", "description": "Connector return code.", "nullable": true }, "returnMessage": { "type": "string", "description": "Connector return message.", "nullable": true }, "status": { "type": "string", "description": "Payment status." }, "connector": { "type": "string", "description": "Connector name.", "nullable": true }, "ConnectorResponses": { "type": "array", "description": "Array containing connector responses information.", "nullable": true, "items": { "type": "object", "description": "Connector responses information.", "properties": { "Tid": { "type": "string", "description": "Provider's unique identifier for the transaction." }, "ReturnCode": { "type": "string", "description": "Connector return code.", "nullable": true }, "Message": { "type": "string", "description": "Connector return message.", "nullable": true }, "authId": { "type": "string", "description": "Authorization identification.", "nullable": true }, "nsu": { "type": "string", "description": "Provider's unique sequential number for the transaction." } } } }, "connectorResponse": { "type": "array", "description": "Array containing connector response information.", "nullable": true, "items": { "type": "object", "description": "Connector response information.", "properties": { "Tid": { "type": "string", "description": "Provider's unique identifier for the transaction." }, "ReturnCode": { "type": "string", "description": "Connector return code.", "nullable": true }, "Message": { "type": "string", "description": "Connector return message.", "nullable": true }, "authId": { "type": "string", "description": "Authorization identification.", "nullable": true }, "nsu": { "type": "string", "description": "Provider's unique sequential number for the transaction." } } } }, "ShowConnectorResponses": { "type": "boolean", "description": "Indicates whether to display connector responses." }, "value": { "type": "number", "description": "Payment value." }, "installmentsInterestRate": { "type": "number", "description": "The interest rate." }, "installmentsValue": { "type": "number", "description": "The value of each installment." }, "referenceValue": { "type": "number", "description": "Value amount of the payment without interest applied. This value is the same as the {value` field when `installmentsInterestRate` is 0.0." }, "installments": { "type": "number", "description": "Number of installments." }, "currencyCode": { "type": "string", "description": "Currency Code in ISO 4217 standard.", "nullable": true }, "provider": { "type": "string", "description": "Provider name.", "nullable": true }, "isBillingAddressDifferent": { "type": "boolean", "description": "Indicates whether the invoice address is different from the purchase delivery address.", "nullable": true }, "isRegexValid": { "type": "boolean", "description": "Confirms that the [Regex](https://regexr.com/) rule is valid.", "nullable": true }, "isLuhnValid": { "type": "boolean", "description": "Confirms that the [Luhn](https://en.wikipedia.org/wiki/Luhn_algorithm) rule is valid.", "nullable": true }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/Fields1" }, "description": "Field containing information and values ​​of payment parameters." }, "sheets": { "type": "string", "description": "Sheets information.", "nullable": true }, "originalPaymentId": { "type": "string", "description": "Original payment identification, if applicable.", "nullable": true } } }, "TransactionSettlementDetails": { "required": [ "requests", "actions" ], "type": "object", "description": "Transaction settlement details response body information.", "properties": { "requests": { "type": "array", "items": { "$ref": "#/components/schemas/Request" }, "description": "Array containing requests information." }, "actions": { "type": "array", "items": { "$ref": "#/components/schemas/Action" }, "description": "Array containing actions information." } } }, "Request": { "required": [ "id", "date", "value" ], "type": "object", "description": "Requests information.", "properties": { "id": { "type": "string", "description": "Transaction identification. This is the same `transactionId` value sent in the request path." }, "date": { "type": "string", "description": "Transaction settlement date." }, "value": { "type": "number", "description": "Transaction settlement value." } } }, "Action": { "required": [ "paymentId", "payment", "date", "type", "value", "connectorResponse" ], "type": "object", "description": "Actions information.", "properties": { "paymentId": { "type": "string", "description": "Payment identification." }, "payment": { "$ref": "#/components/schemas/Payment1" }, "date": { "type": "string", "description": "Transaction settlement date." }, "type": { "type": "string", "description": "Settlement action date." }, "value": { "type": "integer", "description": "Transaction settlement value." }, "connectorResponse": { "type": "string", "description": "Connector transaction response information. This object can return different fields according to the internal configuration of each connector (payment provider), for example, `Tid`, `ReturnCode`, `authId`, among others).", "nullable": true } } }, "Payment1": { "required": [ "href" ], "type": "object", "description": "Object containing the transaction settlement reference route.", "properties": { "href": { "type": "string", "description": "Transaction reference settlement route." } } }, "SettlethetransactionRequest": { "required": [ "value" ], "type": "object", "description": "Settle transaction request body information.", "properties": { "value": { "type": "number", "description": "Value to be settled. The value must be described without using separation for decimals, e.g. to capture a value of 320.50, send 32050.", "example": 10050 } } }, "SettleResponse": { "required": [ "id", "token", "status", "statusDetail", "processingDate", "refundedValue", "refundedToken", "message", "code", "connectorRefundedValue", "cancelledValue" ], "type": "object", "description": " Transaction response body information.", "properties": { "id": { "type": "string", "description": "Settle request identification.", "nullable": true }, "token": { "type": "string", "description": "Token identification." }, "status": { "type": "number", "description": "Status code." }, "statusDetail": { "type": "string", "description": "Status detail information." }, "processingDate": { "type": "string", "description": "Settlement processing date." }, "refundedValue": { "type": "integer", "description": "Refunded value." }, "refundedToken": { "type": "string", "description": "Refund operation token.", "nullable": true }, "message": { "type": "string", "description": "Custom message.", "nullable": true }, "code": { "type": "string", "description": "Custom code.", "nullable": true }, "connectorRefundedValue": { "type": "number", "description": "Refunded value by connector (provider)." }, "cancelledValue": { "type": "integer", "description": "Cancelled value." } } }, "RefundthetransactionRequest": { "required": [ "value" ], "type": "object", "description": "Refund transaction request body information.", "properties": { "value": { "type": "number", "description": "Purchase value. The value must be described without using separation for decimals, e.g. to capture a value of 320.50, send 32050." }, "freight": { "type": "number", "description": "Freigth value, if applicable." }, "tax": { "type": "number", "description": "Tax value, if applicable." }, "minicart": { "type": "object", "description": "This field is filled with the content of the cart of the transaction, which can be obtained using [Get Orders](https://developers.vtex.com/docs/api-reference/orders-api?endpoint=get-/api/oms/pvt/orders/-orderId-) or [Transaction Details](https://developers.vtex.com/docs/api-reference/payments-gateway-api?endpoint=get-/api/pvt/transactions/-transactionId-) endpoints. It should only be included for transactions with split payment.", "items": { "type": "array", "description": "Array containing cart items.", "items": { "type": "object", "description": "Cart items information.", "properties": { "id": { "type": "string", "description": "Item identifier.", "example": "122323" }, "name": { "type": "string", "description": "Item name.", "example": "Tenis Preto I" }, "value": { "type": "number", "description": "Item value.", "example": 1000 }, "shippingDiscount": { "type": "integer", "description": "Discount to be applied for the shipping value.", "example": 0 }, "discount": { "type": "integer", "description": "Discount applied on item.", "example": 50 } } } } } } }, "CancelthetransactionRequest": { "required": [ "value" ], "type": "object", "description": "Cancel transaction request body information.", "properties": { "value": { "type": "number", "description": "Value of the purchase that will be cancelled." } } }, "NotifyPaymentRequest": { "required": [ "paymentDate", "valuePaid" ], "type": "object", "description": "Payment notification request body information.", "properties": { "paymentDate": { "type": "string", "description": "Date when the payment was made, in DD/MM/YYYY format." }, "valuePaid": { "type": "number", "description": "Value that was paid." } } } }, "parameters": { "Content-Type": { "name": "Content-Type", "in": "header", "description": "Type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "example": "application/json" } }, "Accept": { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "example": "application/json" } }, "affiliationId": { "name": "affiliationId", "in": "path", "description": "Affiliation (payment or anti-fraud provider) identification.", "required": true, "style": "simple", "schema": { "type": "string", "example": "e046d326-5421-45ab-95ae-f13d37f260b5" } }, "ruleId": { "name": "ruleId", "in": "path", "description": "Rule identification.", "required": true, "style": "simple", "schema": { "type": "string", "example": "fe6c470b-f80b-4bb1-a75c-378617f8767a" } }, "transactionId": { "name": "transactionId", "in": "path", "description": "Transaction identification.", "required": true, "style": "simple", "schema": { "type": "string", "example": "A3BDE325F76B4B758B398D900DF06150" } }, "paymentId": { "name": "paymentId", "in": "path", "description": "Payment identification.", "required": true, "style": "simple", "schema": { "type": "string", "example": "B075A551595A43B0AD48DCD8EB481C7F" } } }, "securitySchemes": { "appKey": { "type": "apiKey", "in": "header", "name": "X-VTEX-API-AppKey", "description": "Unique identifier of the [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys)." }, "appToken": { "type": "apiKey", "in": "header", "name": "X-VTEX-API-AppToken", "description": "Secret token of the [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys)." }, "VtexIdclientAutCookie": { "type": "apiKey", "in": "header", "name": "VtexIdclientAutCookie", "description": "[User token](https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens), valid for 24 hours." } } }, "tags": [ { "name": "Installments" }, { "name": "Configuration" }, { "name": "Transaction Process" }, { "name": "Transaction Flow" } ] }